com.exalead.indexing.analysis.v10

Class DiscardDocument

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.DiscardDocument

All Implemented Interfaces:

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

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

DEPRECATED. It does not stop the processing of the document. To do so, add a custom document processor with the following code:
document.setProcessingFlag(Operation.DISCARD_AND_DELETE); ((AnalysisDocumentProcessingContext) context).stopProcessingAfterCurrentProcessor();

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
static boolean	DEFAULT_LOG_DISCARDED_DOCUMENTS
boolean	logDiscardedDocuments

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
DiscardDocument()
DiscardDocument(DiscardDocument 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 DiscardDocument.
static DiscardDocument	fromString(java.lang.String s) String representation of this DiscardDocument.
boolean	isLogDiscardedDocuments() If true, the URI of each discarded documents is logged on each analysis process log file.
DiscardDocument	makeCopy() Creates and returns a deep copy of this DiscardDocument.
static DiscardDocument	readFrom(java.io.InputStream is) Read this DiscardDocument from an XML fragment.
void	setLogDiscardedDocuments(boolean logDiscardedDocuments) If true, the URI of each discarded documents is logged on each analysis process log file.
java.lang.String	toString() String representation of this DiscardDocument.
DiscardDocument	withAcceptCondition(AcceptCondition acceptCondition)
DiscardDocument	withDataModelClass(java.lang.String dataModelClass)
DiscardDocument	withDataModelProperty(java.lang.String dataModelProperty)
DiscardDocument	withDataModelState(java.lang.String dataModelState)
DiscardDocument	withDisabled(boolean disabled)
DiscardDocument	withDisabled(java.lang.Boolean disabled)
DiscardDocument	withFromDataModel(DocumentProcessor fromDataModel)
DiscardDocument	withLogDiscardedDocuments(boolean logDiscardedDocuments)
DiscardDocument	withLogDiscardedDocuments(java.lang.Boolean logDiscardedDocuments)
DiscardDocument	withName(java.lang.String name)
void	writeTo(java.io.OutputStream os) Write this DiscardDocument 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

logDiscardedDocuments

public boolean logDiscardedDocuments

DEFAULT_LOG_DISCARDED_DOCUMENTS

public static final boolean DEFAULT_LOG_DISCARDED_DOCUMENTS

See Also:

Constant Field Values

Constructor Detail

DiscardDocument

public DiscardDocument()

DiscardDocument

public DiscardDocument(DiscardDocument o)

Copy constructor

Method Detail

withAcceptCondition

public DiscardDocument withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class DocumentProcessor

withName

public DiscardDocument withName(java.lang.String name)

Overrides:

withName in class DocumentProcessor

withDataModelState

public DiscardDocument withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class DocumentProcessor

withFromDataModel

public DiscardDocument withFromDataModel(DocumentProcessor fromDataModel)

withDataModelClass

public DiscardDocument withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class DocumentProcessor

withDataModelProperty

public DiscardDocument withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class DocumentProcessor

withDisabled

public DiscardDocument withDisabled(boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

withDisabled

public DiscardDocument withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

setLogDiscardedDocuments

public void setLogDiscardedDocuments(boolean logDiscardedDocuments)

If true, the URI of each discarded documents is logged on each analysis process log file.

isLogDiscardedDocuments

public boolean isLogDiscardedDocuments()

If true, the URI of each discarded documents is logged on each analysis process log file.

withLogDiscardedDocuments

public DiscardDocument withLogDiscardedDocuments(boolean logDiscardedDocuments)

withLogDiscardedDocuments

public DiscardDocument withLogDiscardedDocuments(java.lang.Boolean logDiscardedDocuments)

makeCopy

public DiscardDocument makeCopy()

Creates and returns a deep copy of this DiscardDocument.

Overrides:

makeCopy in class DocumentProcessor

readFrom

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

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

Overrides:

writeTo in class DocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DiscardDocument.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DiscardDocument.

Overrides:

toString in class DocumentProcessor

check

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

Checks this DiscardDocument.

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