com.exalead.indexing.analysis.v10

Class WildcardIndexing

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

com.exalead.indexing.analysis.v10.WildcardIndexing

All Implemented Interfaces:

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

public class WildcardIndexing
extends SingleContextDocumentProcessor
implements com.exalead.util.Checkable, java.io.Serializable

Computes the input chunk substring to perform efficient prefix/substring/suffix search

See Also:

Serialized Form

Nested Class Summary

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

SingleContextDocumentProcessor.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 int	DEFAULT_EXACT_SCORE
static int	DEFAULT_MAX_STRING_SIZE
static int	DEFAULT_PREFIX_SCORE
static boolean	DEFAULT_PREFIX_SEARCH
static int	DEFAULT_SUBSTRING_SCORE
static boolean	DEFAULT_SUBSTRING_SEARCH
static int	DEFAULT_SUFFIX_SCORE
static boolean	DEFAULT_SUFFIX_SEARCH
int	exactScore
int	maxStringSize
java.lang.String	outputContext
int	prefixScore
boolean	prefixSearch
int	substringScore
boolean	substringSearch
int	suffixScore
boolean	suffixSearch

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

inputContext

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(DocumentProcessor.Transformer<T> transformer, T[] t)
<T> T	accept(SingleContextDocumentProcessor.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this WildcardIndexing.
static WildcardIndexing	fromString(java.lang.String s) String representation of this WildcardIndexing.
int	getExactScore() Specifies the score for an exact match.
int	getMaxStringSize() Specifies the max string size for which this processor will be applied.
java.lang.String	getOutputContext() Stores exact/prefix/substring/suffix in outputContext.
int	getPrefixScore() Specifies the score for a prefix match.
int	getSubstringScore() Specifies the score for a substring match.
int	getSuffixScore() Specifies the score for a suffix match.
boolean	isPrefixSearch() Enables the prefix search.
boolean	isSubstringSearch() Enables the substring search.
boolean	isSuffixSearch() Enables the suffix search.
WildcardIndexing	makeCopy() Creates and returns a deep copy of this WildcardIndexing.
static WildcardIndexing	readFrom(java.io.InputStream is) Read this WildcardIndexing from an XML fragment.
void	setExactScore(int exactScore) Specifies the score for an exact match.
void	setMaxStringSize(int maxStringSize) Specifies the max string size for which this processor will be applied.
void	setOutputContext(java.lang.String outputContext) Stores exact/prefix/substring/suffix in outputContext.
void	setPrefixScore(int prefixScore) Specifies the score for a prefix match.
void	setPrefixSearch(boolean prefixSearch) Enables the prefix search.
void	setSubstringScore(int substringScore) Specifies the score for a substring match.
void	setSubstringSearch(boolean substringSearch) Enables the substring search.
void	setSuffixScore(int suffixScore) Specifies the score for a suffix match.
void	setSuffixSearch(boolean suffixSearch) Enables the suffix search.
java.lang.String	toString() String representation of this WildcardIndexing.
WildcardIndexing	withAcceptCondition(AcceptCondition acceptCondition)
WildcardIndexing	withDataModelClass(java.lang.String dataModelClass)
WildcardIndexing	withDataModelProperty(java.lang.String dataModelProperty)
WildcardIndexing	withDataModelState(java.lang.String dataModelState)
WildcardIndexing	withDisabled(boolean disabled)
WildcardIndexing	withDisabled(java.lang.Boolean disabled)
WildcardIndexing	withExactScore(int exactScore)
WildcardIndexing	withExactScore(java.lang.Integer exactScore)
WildcardIndexing	withFromDataModel(DocumentProcessor fromDataModel)
WildcardIndexing	withInputContext(java.lang.String inputContext)
WildcardIndexing	withMaxStringSize(int maxStringSize)
WildcardIndexing	withMaxStringSize(java.lang.Integer maxStringSize)
WildcardIndexing	withName(java.lang.String name)
WildcardIndexing	withOutputContext(java.lang.String outputContext)
WildcardIndexing	withPrefixScore(int prefixScore)
WildcardIndexing	withPrefixScore(java.lang.Integer prefixScore)
WildcardIndexing	withPrefixSearch(boolean prefixSearch)
WildcardIndexing	withPrefixSearch(java.lang.Boolean prefixSearch)
WildcardIndexing	withSubstringScore(int substringScore)
WildcardIndexing	withSubstringScore(java.lang.Integer substringScore)
WildcardIndexing	withSubstringSearch(boolean substringSearch)
WildcardIndexing	withSubstringSearch(java.lang.Boolean substringSearch)
WildcardIndexing	withSuffixScore(int suffixScore)
WildcardIndexing	withSuffixScore(java.lang.Integer suffixScore)
WildcardIndexing	withSuffixSearch(boolean suffixSearch)
WildcardIndexing	withSuffixSearch(java.lang.Boolean suffixSearch)
void	writeTo(java.io.OutputStream os) Write this WildcardIndexing as an XML fragment

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

getInputContext, setInputContext

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

outputContext

public java.lang.String outputContext

exactScore

public int exactScore

DEFAULT_EXACT_SCORE

public static final int DEFAULT_EXACT_SCORE

See Also:

Constant Field Values

prefixSearch

public boolean prefixSearch

DEFAULT_PREFIX_SEARCH

public static final boolean DEFAULT_PREFIX_SEARCH

See Also:

Constant Field Values

prefixScore

public int prefixScore

DEFAULT_PREFIX_SCORE

public static final int DEFAULT_PREFIX_SCORE

See Also:

Constant Field Values

suffixSearch

public boolean suffixSearch

DEFAULT_SUFFIX_SEARCH

public static final boolean DEFAULT_SUFFIX_SEARCH

See Also:

Constant Field Values

suffixScore

public int suffixScore

DEFAULT_SUFFIX_SCORE

public static final int DEFAULT_SUFFIX_SCORE

See Also:

Constant Field Values

substringSearch

public boolean substringSearch

DEFAULT_SUBSTRING_SEARCH

public static final boolean DEFAULT_SUBSTRING_SEARCH

See Also:

Constant Field Values

substringScore

public int substringScore

DEFAULT_SUBSTRING_SCORE

public static final int DEFAULT_SUBSTRING_SCORE

See Also:

Constant Field Values

maxStringSize

public int maxStringSize

DEFAULT_MAX_STRING_SIZE

public static final int DEFAULT_MAX_STRING_SIZE

See Also:

Constant Field Values

Constructor Detail

WildcardIndexing

public WildcardIndexing()

WildcardIndexing

public WildcardIndexing(WildcardIndexing o)

Copy constructor

Method Detail

withInputContext

public WildcardIndexing withInputContext(java.lang.String inputContext)

Overrides:

withInputContext in class SingleContextDocumentProcessor

withAcceptCondition

public WildcardIndexing withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class SingleContextDocumentProcessor

withName

public WildcardIndexing withName(java.lang.String name)

Overrides:

withName in class SingleContextDocumentProcessor

withDataModelState

public WildcardIndexing withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SingleContextDocumentProcessor

withFromDataModel

public WildcardIndexing withFromDataModel(DocumentProcessor fromDataModel)

Overrides:

withFromDataModel in class SingleContextDocumentProcessor

withDataModelClass

public WildcardIndexing withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SingleContextDocumentProcessor

withDataModelProperty

public WildcardIndexing withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SingleContextDocumentProcessor

withDisabled

public WildcardIndexing withDisabled(boolean disabled)

Overrides:

withDisabled in class SingleContextDocumentProcessor

withDisabled

public WildcardIndexing withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SingleContextDocumentProcessor

setOutputContext

public void setOutputContext(java.lang.String outputContext)

Stores exact/prefix/substring/suffix in outputContext.
If outputContext = inputContext, it removes the original chunk.

getOutputContext

public java.lang.String getOutputContext()

Stores exact/prefix/substring/suffix in outputContext.
If outputContext = inputContext, it removes the original chunk.

withOutputContext

public WildcardIndexing withOutputContext(java.lang.String outputContext)

setExactScore

public void setExactScore(int exactScore)

Specifies the score for an exact match.

getExactScore

public int getExactScore()

Specifies the score for an exact match.

withExactScore

public WildcardIndexing withExactScore(int exactScore)

withExactScore

public WildcardIndexing withExactScore(java.lang.Integer exactScore)

setPrefixSearch

public void setPrefixSearch(boolean prefixSearch)

Enables the prefix search.

isPrefixSearch

public boolean isPrefixSearch()

Enables the prefix search.

withPrefixSearch

public WildcardIndexing withPrefixSearch(boolean prefixSearch)

withPrefixSearch

public WildcardIndexing withPrefixSearch(java.lang.Boolean prefixSearch)

setPrefixScore

public void setPrefixScore(int prefixScore)

Specifies the score for a prefix match.

getPrefixScore

public int getPrefixScore()

Specifies the score for a prefix match.

withPrefixScore

public WildcardIndexing withPrefixScore(int prefixScore)

withPrefixScore

public WildcardIndexing withPrefixScore(java.lang.Integer prefixScore)

setSuffixSearch

public void setSuffixSearch(boolean suffixSearch)

Enables the suffix search.

isSuffixSearch

public boolean isSuffixSearch()

Enables the suffix search.

withSuffixSearch

public WildcardIndexing withSuffixSearch(boolean suffixSearch)

withSuffixSearch

public WildcardIndexing withSuffixSearch(java.lang.Boolean suffixSearch)

setSuffixScore

public void setSuffixScore(int suffixScore)

Specifies the score for a suffix match.

getSuffixScore

public int getSuffixScore()

Specifies the score for a suffix match.

withSuffixScore

public WildcardIndexing withSuffixScore(int suffixScore)

withSuffixScore

public WildcardIndexing withSuffixScore(java.lang.Integer suffixScore)

setSubstringSearch

public void setSubstringSearch(boolean substringSearch)

Enables the substring search.

isSubstringSearch

public boolean isSubstringSearch()

Enables the substring search.

withSubstringSearch

public WildcardIndexing withSubstringSearch(boolean substringSearch)

withSubstringSearch

public WildcardIndexing withSubstringSearch(java.lang.Boolean substringSearch)

setSubstringScore

public void setSubstringScore(int substringScore)

Specifies the score for a substring match.

getSubstringScore

public int getSubstringScore()

Specifies the score for a substring match.

withSubstringScore

public WildcardIndexing withSubstringScore(int substringScore)

withSubstringScore

public WildcardIndexing withSubstringScore(java.lang.Integer substringScore)

setMaxStringSize

public void setMaxStringSize(int maxStringSize)

Specifies the max string size for which this processor will be applied.

getMaxStringSize

public int getMaxStringSize()

Specifies the max string size for which this processor will be applied.

withMaxStringSize

public WildcardIndexing withMaxStringSize(int maxStringSize)

withMaxStringSize

public WildcardIndexing withMaxStringSize(java.lang.Integer maxStringSize)

makeCopy

public WildcardIndexing makeCopy()

Creates and returns a deep copy of this WildcardIndexing.

Overrides:

makeCopy in class SingleContextDocumentProcessor

readFrom

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

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

Overrides:

writeTo in class SingleContextDocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this WildcardIndexing.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this WildcardIndexing.

Overrides:

toString in class SingleContextDocumentProcessor

check

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

Checks this WildcardIndexing.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SingleContextDocumentProcessor

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class SingleContextDocumentProcessor

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