com.exalead.indexing.analysis.v10

Class SemanticPipeDocumentProcessor

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.SemanticPipeDocumentProcessor

All Implemented Interfaces:

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

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

Instantiates a semantic pipe and creates chunks out of resulting annotations.
It can be used to instantiate classification processors, and perform document level operations from their output.

See Also:

Serialized Form

Nested Class Summary

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	annotations
static boolean	DEFAULT_TOP_LEVEL_ANNOTATIONS_ONLY
java.lang.String	pipeline Deprecated.
java.util.List<SemanticProcessor>	semanticProcessor
boolean	topLevelAnnotationsOnly

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
SemanticPipeDocumentProcessor()
SemanticPipeDocumentProcessor(SemanticPipeDocumentProcessor o) Copy constructor

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 SemanticPipeDocumentProcessor.
static SemanticPipeDocumentProcessor	fromString(java.lang.String s) String representation of this SemanticPipeDocumentProcessor.
java.lang.String	getAnnotations() A chunk will be created for each annotation which name is in the list.
java.lang.String	getPipeline() Deprecated.
java.util.List<SemanticProcessor>	getSemanticProcessor() List of semantic processors to use
boolean	isTopLevelAnnotationsOnly() Considers top level annotations only.
SemanticPipeDocumentProcessor	makeCopy() Creates and returns a deep copy of this SemanticPipeDocumentProcessor.
static SemanticPipeDocumentProcessor	readFrom(java.io.InputStream is) Read this SemanticPipeDocumentProcessor from an XML fragment.
void	setAnnotations(java.lang.String annotations) A chunk will be created for each annotation which name is in the list.
void	setPipeline(java.lang.String pipeline) Deprecated.
void	setTopLevelAnnotationsOnly(boolean topLevelAnnotationsOnly) Considers top level annotations only.
java.lang.String	toString() String representation of this SemanticPipeDocumentProcessor.
SemanticPipeDocumentProcessor	withAcceptCondition(AcceptCondition acceptCondition)
SemanticPipeDocumentProcessor	withAnnotations(java.lang.String annotations)
SemanticPipeDocumentProcessor	withDataModelClass(java.lang.String dataModelClass)
SemanticPipeDocumentProcessor	withDataModelProperty(java.lang.String dataModelProperty)
SemanticPipeDocumentProcessor	withDataModelState(java.lang.String dataModelState)
SemanticPipeDocumentProcessor	withDisabled(boolean disabled)
SemanticPipeDocumentProcessor	withDisabled(java.lang.Boolean disabled)
SemanticPipeDocumentProcessor	withFromDataModel(DocumentProcessor fromDataModel)
SemanticPipeDocumentProcessor	withName(java.lang.String name)
SemanticPipeDocumentProcessor	withPipeline(java.lang.String pipeline) Deprecated.
SemanticPipeDocumentProcessor	withSemanticProcessor(java.util.Collection<SemanticProcessor> __values)
SemanticPipeDocumentProcessor	withSemanticProcessor(SemanticProcessor... __values) List of semantic processors to use
SemanticPipeDocumentProcessor	withTopLevelAnnotationsOnly(boolean topLevelAnnotationsOnly)
SemanticPipeDocumentProcessor	withTopLevelAnnotationsOnly(java.lang.Boolean topLevelAnnotationsOnly)
void	writeTo(java.io.OutputStream os) Write this SemanticPipeDocumentProcessor 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

pipeline

@Deprecated
public java.lang.String pipeline

Deprecated.

semanticProcessor

public java.util.List<SemanticProcessor> semanticProcessor

annotations

public java.lang.String annotations

topLevelAnnotationsOnly

public boolean topLevelAnnotationsOnly

DEFAULT_TOP_LEVEL_ANNOTATIONS_ONLY

public static final boolean DEFAULT_TOP_LEVEL_ANNOTATIONS_ONLY

See Also:

Constant Field Values

Constructor Detail

SemanticPipeDocumentProcessor

public SemanticPipeDocumentProcessor()

SemanticPipeDocumentProcessor

public SemanticPipeDocumentProcessor(SemanticPipeDocumentProcessor o)

Copy constructor

Method Detail

withAcceptCondition

public SemanticPipeDocumentProcessor withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class DocumentProcessor

withName

public SemanticPipeDocumentProcessor withName(java.lang.String name)

Overrides:

withName in class DocumentProcessor

withDataModelState

public SemanticPipeDocumentProcessor withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class DocumentProcessor

withFromDataModel

public SemanticPipeDocumentProcessor withFromDataModel(DocumentProcessor fromDataModel)

withDataModelClass

public SemanticPipeDocumentProcessor withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class DocumentProcessor

withDataModelProperty

public SemanticPipeDocumentProcessor withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class DocumentProcessor

withDisabled

public SemanticPipeDocumentProcessor withDisabled(boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

withDisabled

public SemanticPipeDocumentProcessor withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

setPipeline

@Deprecated
public void setPipeline(java.lang.String pipeline)

Deprecated.

Analysis pipeline on which semantic processors will be used.

getPipeline

@Deprecated
public java.lang.String getPipeline()

Deprecated.

Analysis pipeline on which semantic processors will be used.

withPipeline

@Deprecated
public SemanticPipeDocumentProcessor withPipeline(java.lang.String pipeline)

Deprecated.

getSemanticProcessor

public java.util.List<SemanticProcessor> getSemanticProcessor()

List of semantic processors to use

withSemanticProcessor

public SemanticPipeDocumentProcessor withSemanticProcessor(SemanticProcessor... __values)

List of semantic processors to use

withSemanticProcessor

public SemanticPipeDocumentProcessor withSemanticProcessor(java.util.Collection<SemanticProcessor> __values)

setAnnotations

public void setAnnotations(java.lang.String annotations)

A chunk will be created for each annotation which name is in the list. Comma-separated list of annotations.

getAnnotations

public java.lang.String getAnnotations()

A chunk will be created for each annotation which name is in the list. Comma-separated list of annotations.

withAnnotations

public SemanticPipeDocumentProcessor withAnnotations(java.lang.String annotations)

setTopLevelAnnotationsOnly

public void setTopLevelAnnotationsOnly(boolean topLevelAnnotationsOnly)

Considers top level annotations only. For example, results from the QueryMatcher or Fast Rules.

isTopLevelAnnotationsOnly

public boolean isTopLevelAnnotationsOnly()

Considers top level annotations only. For example, results from the QueryMatcher or Fast Rules.

withTopLevelAnnotationsOnly

public SemanticPipeDocumentProcessor withTopLevelAnnotationsOnly(boolean topLevelAnnotationsOnly)

withTopLevelAnnotationsOnly

public SemanticPipeDocumentProcessor withTopLevelAnnotationsOnly(java.lang.Boolean topLevelAnnotationsOnly)

makeCopy

public SemanticPipeDocumentProcessor makeCopy()

Creates and returns a deep copy of this SemanticPipeDocumentProcessor.

Overrides:

makeCopy in class DocumentProcessor

readFrom

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

Read this SemanticPipeDocumentProcessor 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 SemanticPipeDocumentProcessor as an XML fragment

Overrides:

writeTo in class DocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SemanticPipeDocumentProcessor.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SemanticPipeDocumentProcessor.

Overrides:

toString in class DocumentProcessor

check

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

Checks this SemanticPipeDocumentProcessor.

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