com.exalead.indexing.analysis.v10

Class CompoundWordSplitter

java.lang.Object

com.exalead.indexing.analysis.v10.SemanticProcessor

com.exalead.indexing.analysis.v10.CompoundWordSplitter

All Implemented Interfaces:

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

public class CompoundWordSplitter
extends SemanticProcessor
implements com.exalead.util.Checkable, java.io.Serializable

Annotates compound words that use CamelCase (like SearchServer) or underscores (like my_variable) to separate the root words. This allows users to search for the root words individually. Annotations generated:

• "compound": for example, compound="search server"

See Also:

Serialized Form

Nested Class Summary

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

SemanticProcessor.FromDataModel, SemanticProcessor.Transformer<T>, SemanticProcessor.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_DO_CAMEL_CASE
static boolean	DEFAULT_DO_UNDERSCORE
static boolean	DEFAULT_TOKENIZE_ANNOTATIONS
boolean	doCamelCase
boolean	doUnderscore
boolean	tokenizeAnnotations

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

contexts, dataModelClass, dataModelProperty, dataModelState, DEFAULT_DISABLED, disabled, fromDataModel, name

Constructor Summary

Constructors

Constructor and Description
CompoundWordSplitter()
CompoundWordSplitter(CompoundWordSplitter o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(SemanticProcessor.Transformer<T> transformer, T[] t)
void	accept(SemanticProcessor.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this CompoundWordSplitter.
static CompoundWordSplitter	fromString(java.lang.String s) String representation of this CompoundWordSplitter.
boolean	isDoCamelCase() Separates compound words before each capital letter.
boolean	isDoUnderscore() Separates multi-word strings wherever there is an underscore.
boolean	isTokenizeAnnotations() Subtokenizes "SearchServer" into "Search" "Server" automatically, and keep original annotations.
CompoundWordSplitter	makeCopy() Creates and returns a deep copy of this CompoundWordSplitter.
static CompoundWordSplitter	readFrom(java.io.InputStream is) Read this CompoundWordSplitter from an XML fragment.
void	setDoCamelCase(boolean doCamelCase) Separates compound words before each capital letter.
void	setDoUnderscore(boolean doUnderscore) Separates multi-word strings wherever there is an underscore.
void	setTokenizeAnnotations(boolean tokenizeAnnotations) Subtokenizes "SearchServer" into "Search" "Server" automatically, and keep original annotations.
java.lang.String	toString() String representation of this CompoundWordSplitter.
CompoundWordSplitter	withContexts(java.lang.String contexts)
CompoundWordSplitter	withDataModelClass(java.lang.String dataModelClass)
CompoundWordSplitter	withDataModelProperty(java.lang.String dataModelProperty)
CompoundWordSplitter	withDataModelState(java.lang.String dataModelState)
CompoundWordSplitter	withDisabled(boolean disabled)
CompoundWordSplitter	withDisabled(java.lang.Boolean disabled)
CompoundWordSplitter	withDoCamelCase(boolean doCamelCase)
CompoundWordSplitter	withDoCamelCase(java.lang.Boolean doCamelCase)
CompoundWordSplitter	withDoUnderscore(boolean doUnderscore)
CompoundWordSplitter	withDoUnderscore(java.lang.Boolean doUnderscore)
CompoundWordSplitter	withFromDataModel(SemanticProcessor fromDataModel)
CompoundWordSplitter	withName(java.lang.String name)
CompoundWordSplitter	withTokenizeAnnotations(boolean tokenizeAnnotations)
CompoundWordSplitter	withTokenizeAnnotations(java.lang.Boolean tokenizeAnnotations)
void	writeTo(java.io.OutputStream os) Write this CompoundWordSplitter as an XML fragment

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

getContexts, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setContexts, 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

tokenizeAnnotations

public boolean tokenizeAnnotations

DEFAULT_TOKENIZE_ANNOTATIONS

public static final boolean DEFAULT_TOKENIZE_ANNOTATIONS

See Also:

Constant Field Values

doCamelCase

public boolean doCamelCase

DEFAULT_DO_CAMEL_CASE

public static final boolean DEFAULT_DO_CAMEL_CASE

See Also:

Constant Field Values

doUnderscore

public boolean doUnderscore

DEFAULT_DO_UNDERSCORE

public static final boolean DEFAULT_DO_UNDERSCORE

See Also:

Constant Field Values

Constructor Detail

CompoundWordSplitter

public CompoundWordSplitter()

CompoundWordSplitter

public CompoundWordSplitter(CompoundWordSplitter o)

Copy constructor

Method Detail

withName

public CompoundWordSplitter withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public CompoundWordSplitter withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withFromDataModel

public CompoundWordSplitter withFromDataModel(SemanticProcessor fromDataModel)

withDataModelState

public CompoundWordSplitter withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SemanticProcessor

withDataModelClass

public CompoundWordSplitter withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SemanticProcessor

withDataModelProperty

public CompoundWordSplitter withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SemanticProcessor

withDisabled

public CompoundWordSplitter withDisabled(boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

withDisabled

public CompoundWordSplitter withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

setTokenizeAnnotations

public void setTokenizeAnnotations(boolean tokenizeAnnotations)

Subtokenizes "SearchServer" into "Search" "Server" automatically, and keep original annotations.

isTokenizeAnnotations

public boolean isTokenizeAnnotations()

Subtokenizes "SearchServer" into "Search" "Server" automatically, and keep original annotations.

withTokenizeAnnotations

public CompoundWordSplitter withTokenizeAnnotations(boolean tokenizeAnnotations)

withTokenizeAnnotations

public CompoundWordSplitter withTokenizeAnnotations(java.lang.Boolean tokenizeAnnotations)

setDoCamelCase

public void setDoCamelCase(boolean doCamelCase)

Separates compound words before each capital letter. For example, the annotation for "CamelCase" is compound="camel case".

isDoCamelCase

public boolean isDoCamelCase()

Separates compound words before each capital letter. For example, the annotation for "CamelCase" is compound="camel case".

withDoCamelCase

public CompoundWordSplitter withDoCamelCase(boolean doCamelCase)

withDoCamelCase

public CompoundWordSplitter withDoCamelCase(java.lang.Boolean doCamelCase)

setDoUnderscore

public void setDoUnderscore(boolean doUnderscore)

Separates multi-word strings wherever there is an underscore. For example, the annotation for "under_score" is compound="under score".

isDoUnderscore

public boolean isDoUnderscore()

Separates multi-word strings wherever there is an underscore. For example, the annotation for "under_score" is compound="under score".

withDoUnderscore

public CompoundWordSplitter withDoUnderscore(boolean doUnderscore)

withDoUnderscore

public CompoundWordSplitter withDoUnderscore(java.lang.Boolean doUnderscore)

makeCopy

public CompoundWordSplitter makeCopy()

Creates and returns a deep copy of this CompoundWordSplitter.

Overrides:

makeCopy in class SemanticProcessor

readFrom

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

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

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this CompoundWordSplitter.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this CompoundWordSplitter.

Overrides:

toString in class SemanticProcessor

check

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

Checks this CompoundWordSplitter.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SemanticProcessor

Throws:

com.exalead.util.TypedException

accept

public void accept(SemanticProcessor.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class SemanticProcessor

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class SemanticProcessor

Throws:

com.exalead.util.TypedException