com.exalead.indexing.analysis.v10

Class StandardPartsMerger

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.StandardPartsMerger

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class StandardPartsMerger
extends DocumentProcessor
implements com.exalead.util.Checkable, java.io.Serializable

This processor does nothing if there are no DocumentParts (only root DocumentChunks).
This processor needs one DocumentPart called the 'Master Part'.
If there is only one part, this part is the 'Master Part'.
If there are multiple parts, the part named after the 'masterPart' attribute is the 'Master Part'.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StandardPartsMerger.PartSpecificContexts

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

DocumentProcessor.FromDataModel, DocumentProcessor.Transformer<T>

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	masterPart
protected StandardPartsMerger.PartSpecificContexts	partSpecificContexts

Fields inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

acceptCondition, dataModelClass, dataModelProperty, dataModelState, DEFAULT_DISABLED, disabled, fromDataModel, name

Constructor Summary

Constructors

Constructor and Description
StandardPartsMerger()
StandardPartsMerger(StandardPartsMerger o) Copy constructor
StandardPartsMerger(java.lang.String masterPart)

Method Summary

Modifier and Type	Method and Description
<T> T	accept(DocumentProcessor.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this StandardPartsMerger.
static StandardPartsMerger	fromString(java.lang.String s) String representation of this StandardPartsMerger.
java.lang.String	getMasterPart() Name of the master part. This name should be "master" to follow the convention used by connectors that send documents composed of multiple parts (e.g.
StandardPartsMerger.PartSpecificContexts	getPartSpecificContexts()
StandardPartsMerger	makeCopy() Creates and returns a deep copy of this StandardPartsMerger.
static StandardPartsMerger	readFrom(java.io.InputStream is) Read this StandardPartsMerger from an XML fragment.
void	setMasterPart(java.lang.String masterPart) Name of the master part. This name should be "master" to follow the convention used by connectors that send documents composed of multiple parts (e.g.
void	setPartSpecificContexts(StandardPartsMerger.PartSpecificContexts __value)
java.lang.String	toString() String representation of this StandardPartsMerger.
StandardPartsMerger	withAcceptCondition(AcceptCondition acceptCondition)
StandardPartsMerger	withDataModelClass(java.lang.String dataModelClass)
StandardPartsMerger	withDataModelProperty(java.lang.String dataModelProperty)
StandardPartsMerger	withDataModelState(java.lang.String dataModelState)
StandardPartsMerger	withDisabled(boolean disabled)
StandardPartsMerger	withDisabled(java.lang.Boolean disabled)
StandardPartsMerger	withFromDataModel(DocumentProcessor fromDataModel)
StandardPartsMerger	withMasterPart(java.lang.String masterPart)
StandardPartsMerger	withName(java.lang.String name)
StandardPartsMerger	withPartSpecificContexts(java.util.Collection<StringValue> __values)
StandardPartsMerger	withPartSpecificContexts(StandardPartsMerger.PartSpecificContexts __value)
StandardPartsMerger	withPartSpecificContexts(StringValue... __values)
void	writeTo(java.io.OutputStream os) Write this StandardPartsMerger as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

getAcceptCondition, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setAcceptCondition, setDataModelClass, setDataModelProperty, setDataModelState, setDisabled, setFromDataModel, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

masterPart

public java.lang.String masterPart

partSpecificContexts

protected StandardPartsMerger.PartSpecificContexts partSpecificContexts

Constructor Detail

StandardPartsMerger

public StandardPartsMerger()

StandardPartsMerger

public StandardPartsMerger(java.lang.String masterPart)

StandardPartsMerger

public StandardPartsMerger(StandardPartsMerger o)

Copy constructor

Method Detail

withAcceptCondition

public StandardPartsMerger withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class DocumentProcessor

withName

public StandardPartsMerger withName(java.lang.String name)

Overrides:

withName in class DocumentProcessor

withDataModelState

public StandardPartsMerger withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class DocumentProcessor

withFromDataModel

public StandardPartsMerger withFromDataModel(DocumentProcessor fromDataModel)

withDataModelClass

public StandardPartsMerger withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class DocumentProcessor

withDataModelProperty

public StandardPartsMerger withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class DocumentProcessor

withDisabled

public StandardPartsMerger withDisabled(boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

withDisabled

public StandardPartsMerger withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

setMasterPart

public void setMasterPart(java.lang.String masterPart)

Name of the master part.
This name should be "master" to follow the convention used by connectors that send documents composed of multiple parts (e.g. mails with attachments).

getMasterPart

public java.lang.String getMasterPart()

Name of the master part.
This name should be "master" to follow the convention used by connectors that send documents composed of multiple parts (e.g. mails with attachments).

withMasterPart

public StandardPartsMerger withMasterPart(java.lang.String masterPart)

getPartSpecificContexts

public StandardPartsMerger.PartSpecificContexts getPartSpecificContexts()

setPartSpecificContexts

public void setPartSpecificContexts(StandardPartsMerger.PartSpecificContexts __value)

withPartSpecificContexts

public StandardPartsMerger withPartSpecificContexts(StringValue... __values)

withPartSpecificContexts

public StandardPartsMerger withPartSpecificContexts(java.util.Collection<StringValue> __values)

withPartSpecificContexts

public StandardPartsMerger withPartSpecificContexts(StandardPartsMerger.PartSpecificContexts __value)

makeCopy

public StandardPartsMerger makeCopy()

Creates and returns a deep copy of this StandardPartsMerger.

Overrides:

makeCopy in class DocumentProcessor

readFrom

public static StandardPartsMerger readFrom(java.io.InputStream is)
                                    throws javax.xml.bind.JAXBException

Read this StandardPartsMerger from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this StandardPartsMerger as an XML fragment

Overrides:

writeTo in class DocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static StandardPartsMerger fromString(java.lang.String s)
                                      throws javax.xml.bind.JAXBException,
                                             java.io.UnsupportedEncodingException

String representation of this StandardPartsMerger.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this StandardPartsMerger.

Overrides:

toString in class DocumentProcessor

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this StandardPartsMerger.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class DocumentProcessor

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(DocumentProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class DocumentProcessor

Throws:

com.exalead.util.TypedException