com.exalead.indexing.analysis.v10

Class UTF8Checker

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.MultiContextDocumentProcessor

com.exalead.indexing.analysis.v10.UTF8Checker

All Implemented Interfaces:

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

public class UTF8Checker
extends MultiContextDocumentProcessor
implements com.exalead.util.Checkable, java.io.Serializable

Checks that the text passing through is valid UTF-8.
Emits a warning with the document URI and the context name if input is malformed.
Optionally deletes invalid chunks.

See Also:

Serialized Form

Nested Class Summary

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

MultiContextDocumentProcessor.InputContexts, MultiContextDocumentProcessor.Transformer<T>

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

DocumentProcessor.FromDataModel

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_DELETE_INVALID_CHUNKS
boolean	deleteInvalidChunks

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

inputContexts

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(DocumentProcessor.Transformer<T> transformer, T[] t)
<T> T	accept(MultiContextDocumentProcessor.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this UTF8Checker.
static UTF8Checker	fromString(java.lang.String s) String representation of this UTF8Checker.
boolean	isDeleteInvalidChunks() Removes invalid chunks from documents.
UTF8Checker	makeCopy() Creates and returns a deep copy of this UTF8Checker.
static UTF8Checker	readFrom(java.io.InputStream is) Read this UTF8Checker from an XML fragment.
void	setDeleteInvalidChunks(boolean deleteInvalidChunks) Removes invalid chunks from documents.
java.lang.String	toString() String representation of this UTF8Checker.
UTF8Checker	withAcceptCondition(AcceptCondition acceptCondition)
UTF8Checker	withDataModelClass(java.lang.String dataModelClass)
UTF8Checker	withDataModelProperty(java.lang.String dataModelProperty)
UTF8Checker	withDataModelState(java.lang.String dataModelState)
UTF8Checker	withDeleteInvalidChunks(boolean deleteInvalidChunks)
UTF8Checker	withDeleteInvalidChunks(java.lang.Boolean deleteInvalidChunks)
UTF8Checker	withDisabled(boolean disabled)
UTF8Checker	withDisabled(java.lang.Boolean disabled)
UTF8Checker	withFromDataModel(DocumentProcessor fromDataModel)
UTF8Checker	withInputContexts(java.util.Collection<StringValue> __values)
UTF8Checker	withInputContexts(StringValue... __values) The processor will only be applied to DocumentChunks with a ContextName specified in this list.
UTF8Checker	withName(java.lang.String name)
void	writeTo(java.io.OutputStream os) Write this UTF8Checker as an XML fragment

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

getInputContexts, setInputContexts, withInputContexts

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

deleteInvalidChunks

public boolean deleteInvalidChunks

DEFAULT_DELETE_INVALID_CHUNKS

public static final boolean DEFAULT_DELETE_INVALID_CHUNKS

See Also:

Constant Field Values

Constructor Detail

UTF8Checker

public UTF8Checker()

UTF8Checker

public UTF8Checker(UTF8Checker o)

Copy constructor

Method Detail

withInputContexts

public UTF8Checker withInputContexts(StringValue... __values)

The processor will only be applied to DocumentChunks with a ContextName specified in this list.

Overrides:

withInputContexts in class MultiContextDocumentProcessor

withInputContexts

public UTF8Checker withInputContexts(java.util.Collection<StringValue> __values)

Overrides:

withInputContexts in class MultiContextDocumentProcessor

withAcceptCondition

public UTF8Checker withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class MultiContextDocumentProcessor

withName

public UTF8Checker withName(java.lang.String name)

Overrides:

withName in class MultiContextDocumentProcessor

withDataModelState

public UTF8Checker withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class MultiContextDocumentProcessor

withFromDataModel

public UTF8Checker withFromDataModel(DocumentProcessor fromDataModel)

Overrides:

withFromDataModel in class MultiContextDocumentProcessor

withDataModelClass

public UTF8Checker withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class MultiContextDocumentProcessor

withDataModelProperty

public UTF8Checker withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class MultiContextDocumentProcessor

withDisabled

public UTF8Checker withDisabled(boolean disabled)

Overrides:

withDisabled in class MultiContextDocumentProcessor

withDisabled

public UTF8Checker withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class MultiContextDocumentProcessor

setDeleteInvalidChunks

public void setDeleteInvalidChunks(boolean deleteInvalidChunks)

Removes invalid chunks from documents.

isDeleteInvalidChunks

public boolean isDeleteInvalidChunks()

Removes invalid chunks from documents.

withDeleteInvalidChunks

public UTF8Checker withDeleteInvalidChunks(boolean deleteInvalidChunks)

withDeleteInvalidChunks

public UTF8Checker withDeleteInvalidChunks(java.lang.Boolean deleteInvalidChunks)

makeCopy

public UTF8Checker makeCopy()

Creates and returns a deep copy of this UTF8Checker.

Overrides:

makeCopy in class MultiContextDocumentProcessor

readFrom

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

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

Overrides:

writeTo in class MultiContextDocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this UTF8Checker.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this UTF8Checker.

Overrides:

toString in class MultiContextDocumentProcessor

check

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

Checks this UTF8Checker.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class MultiContextDocumentProcessor

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class MultiContextDocumentProcessor

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