com.exalead.indexing.analysis.v10

Class ContentCleanup

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.MultiContextDocumentProcessor

com.exalead.indexing.analysis.v10.ContentCleanup

All Implemented Interfaces:

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

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

Analyzes each DocumentChunk and performs whitespace removal, 'Whitespaces' being defined by the Unicode specification.
This includes ' ' '\r' and '\n'.
Input: All DocumentChunks associated with the specified 'inputContext' ContextNames.
Output: Same as input

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_DUPLICATE_WHITESPACES
static boolean	DEFAULT_LEADING
static boolean	DEFAULT_SPACES
static boolean	DEFAULT_STRIP_H_T_M_L
static boolean	DEFAULT_TRAILING
boolean	duplicateWhitespaces
boolean	leading
boolean	spaces
boolean	stripHTML
boolean	trailing

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
ContentCleanup()
ContentCleanup(ContentCleanup 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 ContentCleanup.
static ContentCleanup	fromString(java.lang.String s) String representation of this ContentCleanup.
boolean	isDuplicateWhitespaces() Removes duplicate whitespaces.
boolean	isLeading() Removes the leading whitespaces
boolean	isSpaces() Removes *all* whitespaces.
boolean	isStripHTML() Strips HTML tags
boolean	isTrailing() Removes the trailing whitespaces
ContentCleanup	makeCopy() Creates and returns a deep copy of this ContentCleanup.
static ContentCleanup	readFrom(java.io.InputStream is) Read this ContentCleanup from an XML fragment.
void	setDuplicateWhitespaces(boolean duplicateWhitespaces) Removes duplicate whitespaces.
void	setLeading(boolean leading) Removes the leading whitespaces
void	setSpaces(boolean spaces) Removes *all* whitespaces.
void	setStripHTML(boolean stripHTML) Strips HTML tags
void	setTrailing(boolean trailing) Removes the trailing whitespaces
java.lang.String	toString() String representation of this ContentCleanup.
ContentCleanup	withAcceptCondition(AcceptCondition acceptCondition)
ContentCleanup	withDataModelClass(java.lang.String dataModelClass)
ContentCleanup	withDataModelProperty(java.lang.String dataModelProperty)
ContentCleanup	withDataModelState(java.lang.String dataModelState)
ContentCleanup	withDisabled(boolean disabled)
ContentCleanup	withDisabled(java.lang.Boolean disabled)
ContentCleanup	withDuplicateWhitespaces(boolean duplicateWhitespaces)
ContentCleanup	withDuplicateWhitespaces(java.lang.Boolean duplicateWhitespaces)
ContentCleanup	withFromDataModel(DocumentProcessor fromDataModel)
ContentCleanup	withInputContexts(java.util.Collection<StringValue> __values)
ContentCleanup	withInputContexts(StringValue... __values) The processor will only be applied to DocumentChunks with a ContextName specified in this list.
ContentCleanup	withLeading(boolean leading)
ContentCleanup	withLeading(java.lang.Boolean leading)
ContentCleanup	withName(java.lang.String name)
ContentCleanup	withSpaces(boolean spaces)
ContentCleanup	withSpaces(java.lang.Boolean spaces)
ContentCleanup	withStripHTML(boolean stripHTML)
ContentCleanup	withStripHTML(java.lang.Boolean stripHTML)
ContentCleanup	withTrailing(boolean trailing)
ContentCleanup	withTrailing(java.lang.Boolean trailing)
void	writeTo(java.io.OutputStream os) Write this ContentCleanup 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

duplicateWhitespaces

public boolean duplicateWhitespaces

DEFAULT_DUPLICATE_WHITESPACES

public static final boolean DEFAULT_DUPLICATE_WHITESPACES

See Also:

Constant Field Values

leading

public boolean leading

DEFAULT_LEADING

public static final boolean DEFAULT_LEADING

See Also:

Constant Field Values

trailing

public boolean trailing

DEFAULT_TRAILING

public static final boolean DEFAULT_TRAILING

See Also:

Constant Field Values

spaces

public boolean spaces

DEFAULT_SPACES

public static final boolean DEFAULT_SPACES

See Also:

Constant Field Values

stripHTML

public boolean stripHTML

DEFAULT_STRIP_H_T_M_L

public static final boolean DEFAULT_STRIP_H_T_M_L

See Also:

Constant Field Values

Constructor Detail

ContentCleanup

public ContentCleanup()

ContentCleanup

public ContentCleanup(ContentCleanup o)

Copy constructor

Method Detail

withInputContexts

public ContentCleanup 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 ContentCleanup withInputContexts(java.util.Collection<StringValue> __values)

Overrides:

withInputContexts in class MultiContextDocumentProcessor

withAcceptCondition

public ContentCleanup withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class MultiContextDocumentProcessor

withName

public ContentCleanup withName(java.lang.String name)

Overrides:

withName in class MultiContextDocumentProcessor

withDataModelState

public ContentCleanup withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class MultiContextDocumentProcessor

withFromDataModel

public ContentCleanup withFromDataModel(DocumentProcessor fromDataModel)

Overrides:

withFromDataModel in class MultiContextDocumentProcessor

withDataModelClass

public ContentCleanup withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class MultiContextDocumentProcessor

withDataModelProperty

public ContentCleanup withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class MultiContextDocumentProcessor

withDisabled

public ContentCleanup withDisabled(boolean disabled)

Overrides:

withDisabled in class MultiContextDocumentProcessor

withDisabled

public ContentCleanup withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class MultiContextDocumentProcessor

setDuplicateWhitespaces

public void setDuplicateWhitespaces(boolean duplicateWhitespaces)

Removes duplicate whitespaces. (' ' -> ' ')

isDuplicateWhitespaces

public boolean isDuplicateWhitespaces()

Removes duplicate whitespaces. (' ' -> ' ')

withDuplicateWhitespaces

public ContentCleanup withDuplicateWhitespaces(boolean duplicateWhitespaces)

withDuplicateWhitespaces

public ContentCleanup withDuplicateWhitespaces(java.lang.Boolean duplicateWhitespaces)

setLeading

public void setLeading(boolean leading)

Removes the leading whitespaces

isLeading

public boolean isLeading()

Removes the leading whitespaces

withLeading

public ContentCleanup withLeading(boolean leading)

withLeading

public ContentCleanup withLeading(java.lang.Boolean leading)

setTrailing

public void setTrailing(boolean trailing)

Removes the trailing whitespaces

isTrailing

public boolean isTrailing()

Removes the trailing whitespaces

withTrailing

public ContentCleanup withTrailing(boolean trailing)

withTrailing

public ContentCleanup withTrailing(java.lang.Boolean trailing)

setSpaces

public void setSpaces(boolean spaces)

Removes *all* whitespaces.

isSpaces

public boolean isSpaces()

Removes *all* whitespaces.

withSpaces

public ContentCleanup withSpaces(boolean spaces)

withSpaces

public ContentCleanup withSpaces(java.lang.Boolean spaces)

setStripHTML

public void setStripHTML(boolean stripHTML)

Strips HTML tags

isStripHTML

public boolean isStripHTML()

Strips HTML tags

withStripHTML

public ContentCleanup withStripHTML(boolean stripHTML)

withStripHTML

public ContentCleanup withStripHTML(java.lang.Boolean stripHTML)

makeCopy

public ContentCleanup makeCopy()

Creates and returns a deep copy of this ContentCleanup.

Overrides:

makeCopy in class MultiContextDocumentProcessor

readFrom

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

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

Overrides:

writeTo in class MultiContextDocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ContentCleanup.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ContentCleanup.

Overrides:

toString in class MultiContextDocumentProcessor

check

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

Checks this ContentCleanup.

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