com.attivio.sdk.ingest

Class BulkUpdate

java.lang.Object

com.attivio.sdk.esb.AbstractPlatformMessage

com.attivio.sdk.ingest.AbstractIndexMessage

com.attivio.sdk.ingest.BulkUpdate

All Implemented Interfaces:

GroupedMessage, PlatformMessage, IndexMessage, Serializable, Cloneable

public class BulkUpdate
extends AbstractIndexMessage
implements GroupedMessage

Message that applies a "template" document to multiple document ids.

This message allows specifying a query and/or a list of document IDs to apply this update to.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.attivio.sdk.esb.PlatformMessage

DEFAULT_MAX_LOG_LENGTH, MESSAGE_DROPPED, MESSAGE_SEND_TIME_PROP, PROP_MAX_LOG_LENGTH

Constructor Summary

Constructors

Constructor and Description
BulkUpdate()
BulkUpdate(DocumentMode mode)
BulkUpdate(UUID cid, DocumentMode mode)
BulkUpdate(UUID cid, String workflow, DocumentMode mode)
BulkUpdate(UUID cid, WorkflowQueue workflow, DocumentMode mode)

Method Summary

Modifier and Type	Method and Description
void	addDocumentId(String id) Add a Document ID to apply this bulk update to.
void	addDocumentIds(Iterable<String> value) Add Document IDs to apply this bulk update to.
void	addDocumentIds(String... value) Add Document IDs to apply this bulk update to.
void	addMessageToGroup(GroupedMessage msg) Adds msg to the group.
void	addZone(String zone) Add a zone that this bulk update should apply to.
BulkUpdate	clone() Clones the object and resets message ID to -1.
boolean	equals(Object other)
IngestDocument	getDocument() Get the template document for this bulk update.
Set<String>	getDocumentIds() Get the document IDs to apply this update to.
DocumentMode	getDocumentMode() Get the DocumentMode for applying this bulk update.
GroupedMessageId	getGroupedMessageId()
Query	getQuery() Get the query for selecting documents to update.
WorkflowQueue	getQueryWorkflowQueue() Get the workflows to send the selection query through.
String	getSchemaName() Get the name of the schema to use for query processing.
Set<String>	getZones() Get the zones to apply this bulk update to.
int	hashCode()
void	setDocumentIds(Iterable<String> values) Set the document IDs to apply this update to.
void	setDocumentIds(String... values) Set the document IDs to apply this update to.
void	setDocumentMode(DocumentMode mode) Set the DocumentMode for applying this bulk update.
void	setGroupedMessageId(GroupedMessageId groupedMessageId) Sets the GroupedMessageId for this message.
void	setQuery(Query query) Set the query for selecting documents to update.
void	setQuery(String query) Set the query for selecting documents to update.
void	setQuery(String query, String language) Set the query for selecting documents to update.
void	setQueryWorkflowQueue(String... workflows) Set the workflows to send the selection query through.
void	setQueryWorkflowQueue(WorkflowQueue queue) Set the workflows to send the selection query through.
void	setSchemaName(String name) Set the name of the schema to use for query processing.
void	setZones(Iterable<String> value) Set the zones to apply this bulk update to.
void	setZones(String... value) Set the zones to apply this bulk update to.

Methods inherited from class com.attivio.sdk.esb.AbstractPlatformMessage

addMessageHistory, addMessageHistory, getClientId, getEstimatedSize, getMessageHistory, getMessageId, getMetadata, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getWorkflowQueue, getWorkflowQueue, hasProperty, isRedelivered, removeProperty, removeWorkflowQueue, setClientId, setMessageId, setProperty, setRedelivered, setWorkflowQueue, setWorkflowQueue, toMessageString, toString, toString, toString, toString, toString, toString, toString, toString, toString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.attivio.sdk.esb.PlatformMessage

addMessageHistory, addMessageHistory, getClientId, getEstimatedSize, getMessageHistory, getMessageId, getMetadata, getProperty, getWorkflowQueue, getWorkflowQueue, isRedelivered, removeProperty, setClientId, setMessageId, setProperty, setRedelivered, setWorkflowQueue, setWorkflowQueue, toMessageString

Constructor Detail

BulkUpdate

public BulkUpdate()

BulkUpdate

public BulkUpdate(DocumentMode mode)

BulkUpdate

public BulkUpdate(UUID cid,
                  DocumentMode mode)

BulkUpdate

public BulkUpdate(UUID cid,
                  String workflow,
                  DocumentMode mode)

BulkUpdate

public BulkUpdate(UUID cid,
                  WorkflowQueue workflow,
                  DocumentMode mode)

Method Detail

getZones

public Set<String> getZones()

Get the zones to apply this bulk update to.

If null this bulk update will apply to all zones that are not system zones.

setZones

public void setZones(String... value)

Set the zones to apply this bulk update to.

setZones

public void setZones(Iterable<String> value)

Set the zones to apply this bulk update to.

addZone

public void addZone(String zone)

Add a zone that this bulk update should apply to.

getSchemaName

public String getSchemaName()

Get the name of the schema to use for query processing.

setSchemaName

public void setSchemaName(String name)

Set the name of the schema to use for query processing.

getDocument

public IngestDocument getDocument()

Get the template document for this bulk update.

NOTE: the ID on the returned document is irrelevant and will be ignored.

getDocumentMode

public DocumentMode getDocumentMode()

Get the DocumentMode for applying this bulk update.

setDocumentMode

public void setDocumentMode(DocumentMode mode)

Set the DocumentMode for applying this bulk update.

getDocumentIds

public Set<String> getDocumentIds()

Get the document IDs to apply this update to.

setDocumentIds

public void setDocumentIds(String... values)

Set the document IDs to apply this update to.

setDocumentIds

public void setDocumentIds(Iterable<String> values)

Set the document IDs to apply this update to.

addDocumentId

public void addDocumentId(String id)

Add a Document ID to apply this bulk update to.

addDocumentIds

public void addDocumentIds(String... value)

Add Document IDs to apply this bulk update to.

addDocumentIds

public void addDocumentIds(Iterable<String> value)

Add Document IDs to apply this bulk update to.

getQuery

public Query getQuery()

Get the query for selecting documents to update.

setQuery

public void setQuery(Query query)

Set the query for selecting documents to update.

setQuery

public void setQuery(String query)

Set the query for selecting documents to update.

See Also:

QueryString

setQuery

public void setQuery(String query,
                     String language)

Set the query for selecting documents to update.

See Also:

QueryString

getQueryWorkflowQueue

public WorkflowQueue getQueryWorkflowQueue()

Get the workflows to send the selection query through.

setQueryWorkflowQueue

public void setQueryWorkflowQueue(WorkflowQueue queue)

Set the workflows to send the selection query through.

The query workflow is required if a query string is sent in as the query needs to be parsed into a Query.

setQueryWorkflowQueue

public void setQueryWorkflowQueue(String... workflows)

Set the workflows to send the selection query through.

The query workflow is required if a query string is sent in as the query needs to be parsed into a Query.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPlatformMessage

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractPlatformMessage

clone

public BulkUpdate clone()

Clones the object and resets message ID to -1. Clones a message. The message ID is not cloned.

Specified by:

clone in interface PlatformMessage

Specified by:

clone in interface IndexMessage

Overrides:

clone in class AbstractIndexMessage

Returns:

the cloned index message

getGroupedMessageId

public GroupedMessageId getGroupedMessageId()

Specified by:

getGroupedMessageId in interface GroupedMessage

Returns:

the GroupedMessageId for this message

setGroupedMessageId

public void setGroupedMessageId(GroupedMessageId groupedMessageId)

Description copied from interface: GroupedMessage

Sets the GroupedMessageId for this message. This method should normally be used only for the first message in the group with subsequent messages being added to the group via GroupedMessage.addMessageToGroup(GroupedMessage).

Specified by:

setGroupedMessageId in interface GroupedMessage

addMessageToGroup

public void addMessageToGroup(GroupedMessage msg)

Description copied from interface: GroupedMessage

Adds msg to the group. For ordering purposes, msg will appear after this.

Specified by:

addMessageToGroup in interface GroupedMessage