com.exalead.indexing.analysis.v10

Class ContextMapping

java.lang.Object

com.exalead.indexing.analysis.v10.ContextMapping

All Implemented Interfaces:

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

public class ContextMapping
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

ContextMapping specifies how DocumentChunks with a given ContextName are remapped to index fields and whether they are used to populate the dictionary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContextMapping.FromDataModel

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	dataModelClass
java.lang.String	dataModelProperty
java.lang.String	dataModelState
static boolean	DEFAULT_PATTERN_MATCH
static boolean	DEFAULT_PREFIX_MATCH
static int	DEFAULT_RESOURCE_FREQ
static boolean	DEFAULT_SEMANTIC
static boolean	DEFAULT_UNPREFIX
protected ContextMapping.FromDataModel	fromDataModel
java.lang.String	name
boolean	patternMatch
boolean	prefixMatch
int	resourceFreq Deprecated.
boolean	semantic
java.util.List<Target>	target
java.lang.String	tokenizationConfig
boolean	unprefix

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ContextMapping.
static ContextMapping	fromString(java.lang.String s) String representation of this ContextMapping.
java.lang.String	getDataModelClass() If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this context mapping.
java.lang.String	getDataModelProperty() If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this ContextMapping
java.lang.String	getDataModelState() Is this content target managed by a data model?
ContextMapping.FromDataModel	getFromDataModel()
java.lang.String	getName() ContextName of the DocumentChunks to map.
int	getResourceFreq() Deprecated.
java.util.List<Target>	getTarget()
java.lang.String	getTokenizationConfig()
boolean	isPatternMatch() Matches all context matching this pattern (must be a valid regular expression).
boolean	isPrefixMatch() Matches all context that starts with this prefix.
boolean	isSemantic() Performs semantic processing on the DocumentChunks processed by this mapping. If false, the textual content of the DocumentChunks will not be tokenized before indexing.
boolean	isUnprefix() Remove the prefix that was used to match.
ContextMapping	makeCopy() Creates and returns a deep copy of this ContextMapping.
static ContextMapping	readFrom(java.io.InputStream is) Read this ContextMapping from an XML fragment.
void	setDataModelClass(java.lang.String dataModelClass) If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this context mapping.
void	setDataModelProperty(java.lang.String dataModelProperty) If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this ContextMapping
void	setDataModelState(java.lang.String dataModelState) Is this content target managed by a data model?
void	setFromDataModel(ContextMapping.FromDataModel __value)
void	setName(java.lang.String name) ContextName of the DocumentChunks to map.
void	setPatternMatch(boolean patternMatch) Matches all context matching this pattern (must be a valid regular expression).
void	setPrefixMatch(boolean prefixMatch) Matches all context that starts with this prefix.
void	setResourceFreq(int resourceFreq) Deprecated.
void	setSemantic(boolean semantic) Performs semantic processing on the DocumentChunks processed by this mapping. If false, the textual content of the DocumentChunks will not be tokenized before indexing.
void	setTokenizationConfig(java.lang.String tokenizationConfig)
void	setUnprefix(boolean unprefix) Remove the prefix that was used to match.
java.lang.String	toString() String representation of this ContextMapping.
ContextMapping	withDataModelClass(java.lang.String dataModelClass)
ContextMapping	withDataModelProperty(java.lang.String dataModelProperty)
ContextMapping	withDataModelState(java.lang.String dataModelState)
ContextMapping	withName(java.lang.String name)
ContextMapping	withPatternMatch(boolean patternMatch)
ContextMapping	withPatternMatch(java.lang.Boolean patternMatch)
ContextMapping	withPrefixMatch(boolean prefixMatch)
ContextMapping	withPrefixMatch(java.lang.Boolean prefixMatch)
ContextMapping	withResourceFreq(int resourceFreq) Deprecated.
ContextMapping	withResourceFreq(java.lang.Integer resourceFreq) Deprecated.
ContextMapping	withSemantic(boolean semantic)
ContextMapping	withSemantic(java.lang.Boolean semantic)
ContextMapping	withTarget(java.util.Collection<Target> __values)
ContextMapping	withTarget(Target... __values)
ContextMapping	withTokenizationConfig(java.lang.String tokenizationConfig)
ContextMapping	withUnprefix(boolean unprefix)
ContextMapping	withUnprefix(java.lang.Boolean unprefix)
void	writeTo(java.io.OutputStream os) Write this ContextMapping as an XML fragment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

target

public java.util.List<Target> target

name

public java.lang.String name

prefixMatch

public boolean prefixMatch

DEFAULT_PREFIX_MATCH

public static final boolean DEFAULT_PREFIX_MATCH

See Also:

Constant Field Values

unprefix

public boolean unprefix

DEFAULT_UNPREFIX

public static final boolean DEFAULT_UNPREFIX

See Also:

Constant Field Values

patternMatch

public boolean patternMatch

DEFAULT_PATTERN_MATCH

public static final boolean DEFAULT_PATTERN_MATCH

See Also:

Constant Field Values

semantic

public boolean semantic

DEFAULT_SEMANTIC

public static final boolean DEFAULT_SEMANTIC

See Also:

Constant Field Values

resourceFreq

@Deprecated
public int resourceFreq

Deprecated.

DEFAULT_RESOURCE_FREQ

public static final int DEFAULT_RESOURCE_FREQ

See Also:

Constant Field Values

tokenizationConfig

public java.lang.String tokenizationConfig

dataModelState

public java.lang.String dataModelState

fromDataModel

protected ContextMapping.FromDataModel fromDataModel

dataModelClass

public java.lang.String dataModelClass

dataModelProperty

public java.lang.String dataModelProperty

Constructor Detail

ContextMapping

public ContextMapping()

ContextMapping

public ContextMapping(ContextMapping o)

Copy constructor

Method Detail

getTarget

public java.util.List<Target> getTarget()

withTarget

public ContextMapping withTarget(Target... __values)

withTarget

public ContextMapping withTarget(java.util.Collection<Target> __values)

setName

public void setName(java.lang.String name)

ContextName of the DocumentChunks to map.

getName

public java.lang.String getName()

ContextName of the DocumentChunks to map.

withName

public ContextMapping withName(java.lang.String name)

setPrefixMatch

public void setPrefixMatch(boolean prefixMatch)

Matches all context that starts with this prefix.

isPrefixMatch

public boolean isPrefixMatch()

Matches all context that starts with this prefix.

withPrefixMatch

public ContextMapping withPrefixMatch(boolean prefixMatch)

withPrefixMatch

public ContextMapping withPrefixMatch(java.lang.Boolean prefixMatch)

setUnprefix

public void setUnprefix(boolean unprefix)

Remove the prefix that was used to match.

isUnprefix

public boolean isUnprefix()

Remove the prefix that was used to match.

withUnprefix

public ContextMapping withUnprefix(boolean unprefix)

withUnprefix

public ContextMapping withUnprefix(java.lang.Boolean unprefix)

setPatternMatch

public void setPatternMatch(boolean patternMatch)

Matches all context matching this pattern (must be a valid regular expression).

isPatternMatch

public boolean isPatternMatch()

Matches all context matching this pattern (must be a valid regular expression).

withPatternMatch

public ContextMapping withPatternMatch(boolean patternMatch)

withPatternMatch

public ContextMapping withPatternMatch(java.lang.Boolean patternMatch)

setSemantic

public void setSemantic(boolean semantic)

Performs semantic processing on the DocumentChunks processed by this mapping.
If false, the textual content of the DocumentChunks will not be tokenized before indexing. This can be used to index 'exact raw values'.

isSemantic

public boolean isSemantic()

Performs semantic processing on the DocumentChunks processed by this mapping.
If false, the textual content of the DocumentChunks will not be tokenized before indexing. This can be used to index 'exact raw values'.

withSemantic

public ContextMapping withSemantic(boolean semantic)

withSemantic

public ContextMapping withSemantic(java.lang.Boolean semantic)

setResourceFreq

@Deprecated
public void setResourceFreq(int resourceFreq)

Deprecated.

To extract a resource, select the frequency to add.
For example, if you have a 'firstname lastname' entry, you may want to simulate a frequency of 1000 to avoid spellcheck on this entry.

getResourceFreq

@Deprecated
public int getResourceFreq()

Deprecated.

To extract a resource, select the frequency to add.
For example, if you have a 'firstname lastname' entry, you may want to simulate a frequency of 1000 to avoid spellcheck on this entry.

withResourceFreq

@Deprecated
public ContextMapping withResourceFreq(int resourceFreq)

Deprecated.

withResourceFreq

@Deprecated
public ContextMapping withResourceFreq(java.lang.Integer resourceFreq)

Deprecated.

setTokenizationConfig

public void setTokenizationConfig(java.lang.String tokenizationConfig)

getTokenizationConfig

public java.lang.String getTokenizationConfig()

withTokenizationConfig

public ContextMapping withTokenizationConfig(java.lang.String tokenizationConfig)

setDataModelState

public void setDataModelState(java.lang.String dataModelState)

Is this content target managed by a data model?

getDataModelState

public java.lang.String getDataModelState()

Is this content target managed by a data model?

withDataModelState

public ContextMapping withDataModelState(java.lang.String dataModelState)

getFromDataModel

public ContextMapping.FromDataModel getFromDataModel()

setFromDataModel

public void setFromDataModel(ContextMapping.FromDataModel __value)

setDataModelClass

public void setDataModelClass(java.lang.String dataModelClass)

If dataModelState is "auto" or "customized", you will find here the
name of the DataModelClass that generated this context mapping.

getDataModelClass

public java.lang.String getDataModelClass()

If dataModelState is "auto" or "customized", you will find here the
name of the DataModelClass that generated this context mapping.

withDataModelClass

public ContextMapping withDataModelClass(java.lang.String dataModelClass)

setDataModelProperty

public void setDataModelProperty(java.lang.String dataModelProperty)

If dataModelState is "auto" or "customized", you will find here the
name of the DataModelProperty that generated this ContextMapping

getDataModelProperty

public java.lang.String getDataModelProperty()

If dataModelState is "auto" or "customized", you will find here the
name of the DataModelProperty that generated this ContextMapping

withDataModelProperty

public ContextMapping withDataModelProperty(java.lang.String dataModelProperty)

makeCopy

public ContextMapping makeCopy()

Creates and returns a deep copy of this ContextMapping.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ContextMapping.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ContextMapping.

Overrides:

toString in class java.lang.Object

check

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

Checks this ContextMapping.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException