com.exalead.indexing.analysis.v10

Class MappingConfiguration

java.lang.Object

com.exalead.indexing.analysis.v10.MappingConfiguration

All Implemented Interfaces:

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

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

Specifies how DocumentChunks and their SemanticAnnotations populate the index and the dictionary.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<AnnotationMapping>	annotationMapping
java.util.List<ContextMapping>	contextMapping
java.util.List<FieldIndexingLimit>	fieldIndexingLimit
java.util.List<FieldRetrievalLimit>	fieldRetrievalLimit
java.util.List<GenerateAnnotationsForContext>	generateAnnotationsForContext
java.util.List<PartMapping>	partMapping
java.util.List<WordCountMapping>	wordCountMapping

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this MappingConfiguration.
static MappingConfiguration	fromString(java.lang.String s) String representation of this MappingConfiguration.
java.util.List<AnnotationMapping>	getAnnotationMapping() List of mappings from annotations to index targets, with associated parameters.
java.util.List<ContextMapping>	getContextMapping() List mappings from contexts to index targets, with associated parameters.
java.util.List<FieldIndexingLimit>	getFieldIndexingLimit() Word count limits to apply to texts mapped to index fields for search.
java.util.List<FieldRetrievalLimit>	getFieldRetrievalLimit() Size limits (in bytes) to apply to texts mapped to the index for retrieval.
java.util.List<GenerateAnnotationsForContext>	getGenerateAnnotationsForContext() List of contexts to process with a semantic pipeline before mapping.
java.util.List<PartMapping>	getPartMapping() List mappings from parts to index targets, with associated parameters.
java.util.List<WordCountMapping>	getWordCountMapping() Specify where to map Word count.
MappingConfiguration	makeCopy() Creates and returns a deep copy of this MappingConfiguration.
static MappingConfiguration	readFrom(java.io.InputStream is) Read this MappingConfiguration from an XML fragment.
java.lang.String	toString() String representation of this MappingConfiguration.
MappingConfiguration	withAnnotationMapping(AnnotationMapping... __values) List of mappings from annotations to index targets, with associated parameters.
MappingConfiguration	withAnnotationMapping(java.util.Collection<AnnotationMapping> __values)
MappingConfiguration	withContextMapping(java.util.Collection<ContextMapping> __values)
MappingConfiguration	withContextMapping(ContextMapping... __values) List mappings from contexts to index targets, with associated parameters.
MappingConfiguration	withFieldIndexingLimit(java.util.Collection<FieldIndexingLimit> __values)
MappingConfiguration	withFieldIndexingLimit(FieldIndexingLimit... __values) Word count limits to apply to texts mapped to index fields for search.
MappingConfiguration	withFieldRetrievalLimit(java.util.Collection<FieldRetrievalLimit> __values)
MappingConfiguration	withFieldRetrievalLimit(FieldRetrievalLimit... __values) Size limits (in bytes) to apply to texts mapped to the index for retrieval.
MappingConfiguration	withGenerateAnnotationsForContext(java.util.Collection<GenerateAnnotationsForContext> __values)
MappingConfiguration	withGenerateAnnotationsForContext(GenerateAnnotationsForContext... __values) List of contexts to process with a semantic pipeline before mapping.
MappingConfiguration	withPartMapping(java.util.Collection<PartMapping> __values)
MappingConfiguration	withPartMapping(PartMapping... __values) List mappings from parts to index targets, with associated parameters.
MappingConfiguration	withWordCountMapping(java.util.Collection<WordCountMapping> __values)
MappingConfiguration	withWordCountMapping(WordCountMapping... __values) Specify where to map Word count.
void	writeTo(java.io.OutputStream os) Write this MappingConfiguration as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

contextMapping

public java.util.List<ContextMapping> contextMapping

generateAnnotationsForContext

public java.util.List<GenerateAnnotationsForContext> generateAnnotationsForContext

annotationMapping

public java.util.List<AnnotationMapping> annotationMapping

fieldRetrievalLimit

public java.util.List<FieldRetrievalLimit> fieldRetrievalLimit

fieldIndexingLimit

public java.util.List<FieldIndexingLimit> fieldIndexingLimit

partMapping

public java.util.List<PartMapping> partMapping

wordCountMapping

public java.util.List<WordCountMapping> wordCountMapping

Constructor Detail

MappingConfiguration

public MappingConfiguration()

MappingConfiguration

public MappingConfiguration(MappingConfiguration o)

Copy constructor

Method Detail

getContextMapping

public java.util.List<ContextMapping> getContextMapping()

List mappings from contexts to index targets, with associated parameters.

withContextMapping

public MappingConfiguration withContextMapping(ContextMapping... __values)

List mappings from contexts to index targets, with associated parameters.

withContextMapping

public MappingConfiguration withContextMapping(java.util.Collection<ContextMapping> __values)

getGenerateAnnotationsForContext

public java.util.List<GenerateAnnotationsForContext> getGenerateAnnotationsForContext()

List of contexts to process with a semantic pipeline before mapping.

withGenerateAnnotationsForContext

public MappingConfiguration withGenerateAnnotationsForContext(GenerateAnnotationsForContext... __values)

List of contexts to process with a semantic pipeline before mapping.

withGenerateAnnotationsForContext

public MappingConfiguration withGenerateAnnotationsForContext(java.util.Collection<GenerateAnnotationsForContext> __values)

getAnnotationMapping

public java.util.List<AnnotationMapping> getAnnotationMapping()

List of mappings from annotations to index targets, with associated parameters.

withAnnotationMapping

public MappingConfiguration withAnnotationMapping(AnnotationMapping... __values)

List of mappings from annotations to index targets, with associated parameters.

withAnnotationMapping

public MappingConfiguration withAnnotationMapping(java.util.Collection<AnnotationMapping> __values)

getFieldRetrievalLimit

public java.util.List<FieldRetrievalLimit> getFieldRetrievalLimit()

Size limits (in bytes) to apply to texts mapped to the index for retrieval.

withFieldRetrievalLimit

public MappingConfiguration withFieldRetrievalLimit(FieldRetrievalLimit... __values)

Size limits (in bytes) to apply to texts mapped to the index for retrieval.

withFieldRetrievalLimit

public MappingConfiguration withFieldRetrievalLimit(java.util.Collection<FieldRetrievalLimit> __values)

getFieldIndexingLimit

public java.util.List<FieldIndexingLimit> getFieldIndexingLimit()

Word count limits to apply to texts mapped to index fields for search.

withFieldIndexingLimit

public MappingConfiguration withFieldIndexingLimit(FieldIndexingLimit... __values)

Word count limits to apply to texts mapped to index fields for search.

withFieldIndexingLimit

public MappingConfiguration withFieldIndexingLimit(java.util.Collection<FieldIndexingLimit> __values)

getPartMapping

public java.util.List<PartMapping> getPartMapping()

List mappings from parts to index targets, with associated parameters.

withPartMapping

public MappingConfiguration withPartMapping(PartMapping... __values)

List mappings from parts to index targets, with associated parameters.

withPartMapping

public MappingConfiguration withPartMapping(java.util.Collection<PartMapping> __values)

getWordCountMapping

public java.util.List<WordCountMapping> getWordCountMapping()

Specify where to map Word count.

withWordCountMapping

public MappingConfiguration withWordCountMapping(WordCountMapping... __values)

Specify where to map Word count.

withWordCountMapping

public MappingConfiguration withWordCountMapping(java.util.Collection<WordCountMapping> __values)

makeCopy

public MappingConfiguration makeCopy()

Creates and returns a deep copy of this MappingConfiguration.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this MappingConfiguration.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this MappingConfiguration.

Overrides:

toString in class java.lang.Object

check

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

Checks this MappingConfiguration.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException