BatchPublishObject (pdp-cms 5.0.2.3 API)

java.lang.Object
- com.frameworkset.platform.cms.driver.publish.PublishObject
- - com.frameworkset.platform.cms.driver.publish.impl.BatchPublishObject

All Implemented Interfaces:

java.io.Serializable
```
public class BatchPublishObject
extends PublishObject
```
批处理发布对象
Title: BatchPublishObject

Description:

Copyright: Copyright (c) 2006

Company: 三一集团

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String[][]`	`batchObjects` 批量发布对象二维数组封装多个文档的站点，频道，和文档id信息例如:{ {siteid,channelid,docid}, {siteid,channelid,docid}, {siteid,channelid,docid}, ...
`protected int`	`publishObjectType`

Fields inherited from class com.frameworkset.platform.cms.driver.publish.PublishObject
ACTIONTYPE_DESIGN, ACTIONTYPE_PUBLISH, ACTIONTYPE_VIEW, CLEAR_PUBLISH_RESOURCECACHE, clearFileCache, context, currentPublishDepth, DEFAULT_PUBLISH_LOCAL, DISABLE_PUBLISH_CONTENT_RECURSIVE, distributeManners, ENABLE_PUBLISH_CONTENT_RECURSIVE, enableRecursive, isRecursive, isRoot, local2ndRemote, maxPublishDepth, monitor, OBJECT_CHANNEL, OBJECT_DOCUMENT, OBJECT_PAGE, OBJECT_SITE, params, parentContext, PUBLISH_CHANNEL_CONTENT, PUBLISH_CHANNEL_CONTENT_PUBLISHED, PUBLISH_CHANNEL_INDEX, PUBLISH_CHANNEL_RECCONTENT, PUBLISH_CHANNEL_RECINDEX, PUBLISH_DOCUMENT, PUBLISH_LOCAL, PUBLISH_PAGE, PUBLISH_REMOTE, PUBLISH_SITE_INDEX, publisher, publishMode, publishScope, requestContext, scopeToUIID, script, scriptlets, synchronize, USE_PUBLISH_RESOURCECACHE

Constructor Summary

Constructors
Constructor and Description
`BatchPublishObject(CMSRequestContext requestContext, int[] publishScope, java.lang.String[][] batchObjects, java.lang.String[] publisher, boolean isRoot, boolean[] local2ndRemote, int[] distributeManners)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Context`	`buildContext()`
`protected void`	`delteRefObjects()` 删除与发布对象相关的所有相关元素
`void`	`doPublish()`
`protected java.lang.String`	`getId()` 当前发布任务的监控器索引，以发布任务的唯一id为索引发布站点任务：siteid 发布频道任务：channelid + ":" + siteid 发布文档任务：docuemntid + ":" + siteid 当发布任务完成后，将当前任务的监控器删除，任务开始时创建任务的监控器，并且缓冲到索引器中如果需要发布的任务在监控器中存在，那么将提示用户发布任务重复，新的发布任务不允许启动
`int`	`getPublishObjectType()`
`java.util.Set`	`getRecursivePubObject()` 抽象方法，具体的发布对象子类去实现添加与当前任务相关的发布对象到上下文中
`void`	`initScriptlet()`
`boolean`	`isBatchPublish()` 判断发布的文档是否时批处理发布
`protected void`	`publishPages()` 发布模版中包含的普通页面和动态页面发布模版中特定标签中包含的普通页面和动态页面
`void`	`recordRecursivePubObj(java.lang.String refobj, int reftype, java.lang.String site)` 抽象方法，具体的发布对象子类去实现记录当前发布对象与相关发布对象中包含的元素之间的引用关系，当相关的元素发生变化时本方法在发布的过程中由页面的相关元素进行回调
`void`	`setPublishObjectType(int publishObjectType)`

Methods inherited from class com.frameworkset.platform.cms.driver.publish.PublishObject
addMetaData, changeScopeToUIID, checkContext, destroy, disttribute, doBatchPublish, enableRecursive, forceStatusPublished, getActionType, getContext, getCurrentPublishDepth, getDistributeManners, getInnerPublishMonitor, getLocal2ndRemote, getMaxPublishDepth, getPublisher, getPublishMonitor, getPublishObjectID, getPublishPageUrl, getPublishScope, getPublishViewPageUrl, getRequestContext, init, isClearFileCache, isForceStatusPublished, isIncreament, isRecursive, isRoot, isSynchronized, needPublish, parser, publish, reachMaxdeth, recordRecursivePublihsObject, recursivePublish, runPage, saveHtml, setActionType, setClearFileCache, setCurrentPublishDepth, setDistributeManners, setEnableRecursive, setIncreament, setMaxPublishDepth, setMonitor, setRecursive, setSynchronized, setVariable, storeRefObjects

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - batchObjects
```
protected java.lang.String[][] batchObjects
```
    批量发布对象二维数组封装多个文档的站点，频道，和文档id信息例如:{ {siteid,channelid,docid}, {siteid,channelid,docid}, {siteid,channelid,docid}, ... }
  - publishObjectType
```
protected int publishObjectType
```
- Constructor Detail
  - BatchPublishObject
```
public BatchPublishObject(CMSRequestContext requestContext,
                          int[] publishScope,
                          java.lang.String[][] batchObjects,
                          java.lang.String[] publisher,
                          boolean isRoot,
                          boolean[] local2ndRemote,
                          int[] distributeManners)
```
- Method Detail
  - doPublish
```
public void doPublish()
               throws PublishException
```
    Specified by:
    
    doPublish in class PublishObject
    
    Throws:
    
    PublishException
  - buildContext
```
public Context buildContext()
                     throws PublishException
```
    Specified by:
    
    buildContext in class PublishObject
    
    Throws:
    
    PublishException
  - initScriptlet
```
public void initScriptlet()
                   throws PublishException
```
    Specified by:
    
    initScriptlet in class PublishObject
    
    Throws:
    
    PublishException
  - getId
```
protected java.lang.String getId()
```
    Description copied from class: PublishObject
    
    当前发布任务的监控器索引，以发布任务的唯一id为索引发布站点任务：siteid 发布频道任务：channelid + ":" + siteid 发布文档任务：docuemntid + ":" + siteid 当发布任务完成后，将当前任务的监控器删除，任务开始时创建任务的监控器，并且缓冲到索引器中如果需要发布的任务在监控器中存在，那么将提示用户发布任务重复，新的发布任务不允许启动
    
    Specified by:
    
    getId in class PublishObject
  - isBatchPublish
```
public boolean isBatchPublish()
```
    判断发布的文档是否时批处理发布
    
    Overrides:
    
    isBatchPublish in class PublishObject
    
    Returns:
  - getPublishObjectType
```
public int getPublishObjectType()
```
  - setPublishObjectType
```
public void setPublishObjectType(int publishObjectType)
```
  - publishPages
```
protected void publishPages()
```
    Description copied from class: PublishObject
    
    发布模版中包含的普通页面和动态页面发布模版中特定标签中包含的普通页面和动态页面
    
    Overrides:
    
    publishPages in class PublishObject
  - recordRecursivePubObj
```
public void recordRecursivePubObj(java.lang.String refobj,
                                  int reftype,
                                  java.lang.String site)
```
    Description copied from class: PublishObject
    
    抽象方法，具体的发布对象子类去实现记录当前发布对象与相关发布对象中包含的元素之间的引用关系，当相关的元素发生变化时本方法在发布的过程中由页面的相关元素进行回调
    
    Specified by:
    
    recordRecursivePubObj in class PublishObject
  - getRecursivePubObject
```
public java.util.Set getRecursivePubObject()
```
    Description copied from class: PublishObject
    
    抽象方法，具体的发布对象子类去实现添加与当前任务相关的发布对象到上下文中
    
    Specified by:
    
    getRecursivePubObject in class PublishObject
  - delteRefObjects
```
protected void delteRefObjects()
```
    Description copied from class: PublishObject
    
    删除与发布对象相关的所有相关元素
    
    Specified by:
    
    delteRefObjects in class PublishObject

Class BatchPublishObject

Field Summary

Fields inherited from class com.frameworkset.platform.cms.driver.publish.PublishObject

Constructor Summary

Method Summary

Methods inherited from class com.frameworkset.platform.cms.driver.publish.PublishObject

Methods inherited from class java.lang.Object

Field Detail

batchObjects

publishObjectType

Constructor Detail

BatchPublishObject

Method Detail

doPublish

buildContext

initScriptlet

getId

isBatchPublish

getPublishObjectType

setPublishObjectType

publishPages

recordRecursivePubObj

getRecursivePubObject

delteRefObjects