com.exalead.indexing.analysis.v10

Class AnnotationMapping

java.lang.Object

com.exalead.indexing.analysis.v10.AnnotationMapping

All Implemented Interfaces:

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

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

Defines how SemanticAnnotations are used to populate index fields.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnotationMapping.FromDataModel

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<AnnotationTarget>	annotationTarget
java.lang.String	context
java.lang.String	dataModelClass
java.lang.String	dataModelProperty
java.lang.String	dataModelState
static boolean	DEFAULT_PATTERN_MATCH
protected AnnotationMapping.FromDataModel	fromDataModel
java.lang.String	name
boolean	patternMatch

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this AnnotationMapping.
static AnnotationMapping	fromString(java.lang.String s) String representation of this AnnotationMapping.
java.util.List<AnnotationTarget>	getAnnotationTarget()
java.lang.String	getContext() Optional input context restricting the mapping from the annotations coming from a specific context.
java.lang.String	getDataModelClass() If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this annotation mapping.
java.lang.String	getDataModelProperty() If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this annotation mapping.
java.lang.String	getDataModelState() Is this annotation target managed by a data model?
AnnotationMapping.FromDataModel	getFromDataModel()
java.lang.String	getName() Name of the SemanticAnnotation to map.
boolean	isPatternMatch() Matches all annotations matching this pattern (must be a valid regular expression).
AnnotationMapping	makeCopy() Creates and returns a deep copy of this AnnotationMapping.
static AnnotationMapping	readFrom(java.io.InputStream is) Read this AnnotationMapping from an XML fragment.
void	setContext(java.lang.String context) Optional input context restricting the mapping from the annotations coming from a specific context.
void	setDataModelClass(java.lang.String dataModelClass) If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this annotation 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 annotation mapping.
void	setDataModelState(java.lang.String dataModelState) Is this annotation target managed by a data model?
void	setFromDataModel(AnnotationMapping.FromDataModel __value)
void	setName(java.lang.String name) Name of the SemanticAnnotation to map.
void	setPatternMatch(boolean patternMatch) Matches all annotations matching this pattern (must be a valid regular expression).
java.lang.String	toString() String representation of this AnnotationMapping.
AnnotationMapping	withAnnotationTarget(AnnotationTarget... __values)
AnnotationMapping	withAnnotationTarget(java.util.Collection<AnnotationTarget> __values)
AnnotationMapping	withContext(java.lang.String context)
AnnotationMapping	withDataModelClass(java.lang.String dataModelClass)
AnnotationMapping	withDataModelProperty(java.lang.String dataModelProperty)
AnnotationMapping	withDataModelState(java.lang.String dataModelState)
AnnotationMapping	withName(java.lang.String name)
AnnotationMapping	withPatternMatch(boolean patternMatch)
AnnotationMapping	withPatternMatch(java.lang.Boolean patternMatch)
void	writeTo(java.io.OutputStream os) Write this AnnotationMapping as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

annotationTarget

public java.util.List<AnnotationTarget> annotationTarget

name

public java.lang.String name

context

public java.lang.String context

patternMatch

public boolean patternMatch

DEFAULT_PATTERN_MATCH

public static final boolean DEFAULT_PATTERN_MATCH

See Also:

Constant Field Values

dataModelState

public java.lang.String dataModelState

fromDataModel

protected AnnotationMapping.FromDataModel fromDataModel

dataModelClass

public java.lang.String dataModelClass

dataModelProperty

public java.lang.String dataModelProperty

Constructor Detail

AnnotationMapping

public AnnotationMapping()

AnnotationMapping

public AnnotationMapping(AnnotationMapping o)

Copy constructor

Method Detail

getAnnotationTarget

public java.util.List<AnnotationTarget> getAnnotationTarget()

withAnnotationTarget

public AnnotationMapping withAnnotationTarget(AnnotationTarget... __values)

withAnnotationTarget

public AnnotationMapping withAnnotationTarget(java.util.Collection<AnnotationTarget> __values)

setName

public void setName(java.lang.String name)

Name of the SemanticAnnotation to map.

getName

public java.lang.String getName()

Name of the SemanticAnnotation to map.

withName

public AnnotationMapping withName(java.lang.String name)

setContext

public void setContext(java.lang.String context)

Optional input context restricting the mapping from the annotations coming from a specific context.
Incompatible with the patternMatch feature.

getContext

public java.lang.String getContext()

Optional input context restricting the mapping from the annotations coming from a specific context.
Incompatible with the patternMatch feature.

withContext

public AnnotationMapping withContext(java.lang.String context)

setPatternMatch

public void setPatternMatch(boolean patternMatch)

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

isPatternMatch

public boolean isPatternMatch()

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

withPatternMatch

public AnnotationMapping withPatternMatch(boolean patternMatch)

withPatternMatch

public AnnotationMapping withPatternMatch(java.lang.Boolean patternMatch)

setDataModelState

public void setDataModelState(java.lang.String dataModelState)

Is this annotation target managed by a data model?

getDataModelState

public java.lang.String getDataModelState()

Is this annotation target managed by a data model?

withDataModelState

public AnnotationMapping withDataModelState(java.lang.String dataModelState)

getFromDataModel

public AnnotationMapping.FromDataModel getFromDataModel()

setFromDataModel

public void setFromDataModel(AnnotationMapping.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 annotation 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 annotation mapping.

withDataModelClass

public AnnotationMapping 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 annotation mapping.

getDataModelProperty

public java.lang.String getDataModelProperty()

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

withDataModelProperty

public AnnotationMapping withDataModelProperty(java.lang.String dataModelProperty)

makeCopy

public AnnotationMapping makeCopy()

Creates and returns a deep copy of this AnnotationMapping.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this AnnotationMapping.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AnnotationMapping.

Overrides:

toString in class java.lang.Object

check

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

Checks this AnnotationMapping.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException