org.compass.core.mapping.support
Class AbstractResourcePropertyMapping

java.lang.Object
  org.compass.core.mapping.support.AbstractMapping
      org.compass.core.mapping.support.AbstractResourcePropertyMapping

All Implemented Interfaces:

InternalMapping, InternalResourcePropertyMapping, Mapping, ResourcePropertyMapping

Direct Known Subclasses:

ClassPropertyMetaDataMapping, ConstantMetaDataMapping, DynamicMetaDataMapping, JsonContentMapping, JsonPropertyMapping, RawResourcePropertyMapping, XmlContentMapping, XmlPropertyMapping

public abstract class AbstractResourcePropertyMapping
extends AbstractMapping
implements InternalResourcePropertyMapping

Author:

kimchy

Nested Class Summary

Nested classes/interfaces inherited from interface org.compass.core.mapping.ResourcePropertyMapping

ResourcePropertyMapping.ExcludeFromAllType, ResourcePropertyMapping.ReverseType

Constructor Summary

AbstractResourcePropertyMapping()

Method Summary

protected void	copy(AbstractResourcePropertyMapping copy)
String	getAnalyzer() Returns the anayzer name that is associated with the property.
float	getBoost() Returns the boost level.
ResourcePropertyMapping.ExcludeFromAllType	getExcludeFromAll()
Property.Index	getIndex()
String	getNullValue()
String	getOriginalName() Returns the original name of the resource property, before any prefix aditions or any other post processing manipulation.
ResourcePropertyMapping.ReverseType	getReverse()
String	getRootAlias() Returns the root resource mapping alias name this resource property mapping belongs to.
SpellCheckType	getSpellCheck()
Property.Store	getStore()
Property.TermVector	getTermVector()
boolean	hasNullValue()
boolean	isInternal() Returns true if this mapping is an internal one ($/ notation).
Boolean	isOmitNorms() Should the reosurce property omit norms or not.
Boolean	isOmitTf() Expert: If set, omit tf from postings of this indexed field.
void	setAnalyzer(String analyzer)
void	setBoost(float boost)
void	setExcludeFromAll(ResourcePropertyMapping.ExcludeFromAllType excludeFromAll)
void	setIndex(Property.Index index)
void	setInternal(boolean isInternal)
void	setName(String name) Sets the name of the mapping.
void	setNullValue(String nullValue) Allows to set the resource property mapping null value.
void	setOmitNorms(Boolean omitNorms)
void	setOmitTf(Boolean omitTf)
void	setReverse(ResourcePropertyMapping.ReverseType reverse)
void	setRootAlias(String rootAlias)
void	setSpellCheck(SpellCheckType spellCheck)
void	setStore(Property.Store store)
void	setTermVector(Property.TermVector termVector)

Methods inherited from class org.compass.core.mapping.support.AbstractMapping

controlsObjectNullability, copy, getConverter, getConverterName, getName, getPath, setConverter, setConverterName, setPath

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.compass.core.mapping.ResourcePropertyMapping

getResourcePropertyConverter

Methods inherited from interface org.compass.core.mapping.Mapping

controlsObjectNullability, copy, getConverter, getConverterName, getName, getPath

Constructor Detail

AbstractResourcePropertyMapping

public AbstractResourcePropertyMapping()

Method Detail

copy

protected void copy(AbstractResourcePropertyMapping copy)

setName

public void setName(String name)

Description copied from interface: InternalMapping

Sets the name of the mapping. Acts as the "logical" name of the mapping (think Java Bean Property name).

Specified by:

setName in interface InternalMapping

Overrides:

setName in class AbstractMapping

getOriginalName

public String getOriginalName()

Description copied from interface: ResourcePropertyMapping

Returns the original name of the resource property, before any prefix aditions or any other post processing manipulation.

Specified by:

getOriginalName in interface ResourcePropertyMapping

getRootAlias

public String getRootAlias()

Description copied from interface: ResourcePropertyMapping

Returns the root resource mapping alias name this resource property mapping belongs to.

Specified by:

getRootAlias in interface ResourcePropertyMapping

setRootAlias

public void setRootAlias(String rootAlias)

getBoost

public float getBoost()

Description copied from interface: ResourcePropertyMapping

Returns the boost level.

Specified by:

getBoost in interface ResourcePropertyMapping

See Also:

Property.setBoost(float)

setBoost

public void setBoost(float boost)

Specified by:

setBoost in interface InternalResourcePropertyMapping

getStore

public Property.Store getStore()

Specified by:

getStore in interface ResourcePropertyMapping

setStore

public void setStore(Property.Store store)

Specified by:

setStore in interface InternalResourcePropertyMapping

getIndex

public Property.Index getIndex()

Specified by:

getIndex in interface ResourcePropertyMapping

setIndex

public void setIndex(Property.Index index)

Specified by:

setIndex in interface InternalResourcePropertyMapping

isInternal

public boolean isInternal()

Description copied from interface: ResourcePropertyMapping

Returns true if this mapping is an internal one ($/ notation).

Specified by:

isInternal in interface ResourcePropertyMapping

setInternal

public void setInternal(boolean isInternal)

Specified by:

setInternal in interface InternalResourcePropertyMapping

getExcludeFromAll

public ResourcePropertyMapping.ExcludeFromAllType getExcludeFromAll()

Specified by:

getExcludeFromAll in interface ResourcePropertyMapping

setExcludeFromAll

public void setExcludeFromAll(ResourcePropertyMapping.ExcludeFromAllType excludeFromAll)

Specified by:

setExcludeFromAll in interface InternalResourcePropertyMapping

getTermVector

public Property.TermVector getTermVector()

Specified by:

getTermVector in interface ResourcePropertyMapping

setTermVector

public void setTermVector(Property.TermVector termVector)

Specified by:

setTermVector in interface InternalResourcePropertyMapping

getAnalyzer

public String getAnalyzer()

Description copied from interface: ResourcePropertyMapping

Returns the anayzer name that is associated with the property. Can be null (i.e. not set).

Specified by:

getAnalyzer in interface ResourcePropertyMapping

setAnalyzer

public void setAnalyzer(String analyzer)

Specified by:

setAnalyzer in interface InternalResourcePropertyMapping

getReverse

public ResourcePropertyMapping.ReverseType getReverse()

Specified by:

getReverse in interface ResourcePropertyMapping

setReverse

public void setReverse(ResourcePropertyMapping.ReverseType reverse)

Specified by:

setReverse in interface InternalResourcePropertyMapping

isOmitNorms

public Boolean isOmitNorms()

Description copied from interface: ResourcePropertyMapping

Should the reosurce property omit norms or not.

Specified by:

isOmitNorms in interface ResourcePropertyMapping

See Also:

Property.setOmitNorms(boolean)

setOmitNorms

public void setOmitNorms(Boolean omitNorms)

Specified by:

setOmitNorms in interface InternalResourcePropertyMapping

getNullValue

public String getNullValue()

Specified by:

getNullValue in interface ResourcePropertyMapping

isOmitTf

public Boolean isOmitTf()

Description copied from interface: ResourcePropertyMapping

Expert: If set, omit tf from postings of this indexed field.

Specified by:

isOmitTf in interface ResourcePropertyMapping

See Also:

Property.setOmitTf(boolean)

setOmitTf

public void setOmitTf(Boolean omitTf)

Specified by:

setOmitTf in interface InternalResourcePropertyMapping

setNullValue

public void setNullValue(String nullValue)

Description copied from interface: InternalResourcePropertyMapping

Allows to set the resource property mapping null value.

Specified by:

setNullValue in interface InternalResourcePropertyMapping

hasNullValue

public boolean hasNullValue()

Specified by:

hasNullValue in interface ResourcePropertyMapping

getSpellCheck

public SpellCheckType getSpellCheck()

Specified by:

getSpellCheck in interface ResourcePropertyMapping

setSpellCheck

public void setSpellCheck(SpellCheckType spellCheck)

Specified by:

setSpellCheck in interface InternalResourcePropertyMapping