org.compass.core.mapping
Interface ResourcePropertyMapping

All Superinterfaces:
Mapping
All Known Subinterfaces:
InternalResourcePropertyMapping
All Known Implementing Classes:
AbstractResourcePropertyMapping, ClassPropertyMetaDataMapping, ConstantMetaDataMapping, DynamicMetaDataMapping, JsonBoostPropertyMapping, JsonContentMapping, JsonIdMapping, JsonPropertyAnalyzerController, JsonPropertyMapping, RawBoostPropertyMapping, RawResourcePropertyAnalyzerController, RawResourcePropertyIdMapping, RawResourcePropertyMapping, XmlBoostPropertyMapping, XmlContentMapping, XmlIdMapping, XmlPropertyAnalyzerController, XmlPropertyMapping

public interface ResourcePropertyMapping
extends Mapping

Author:
kimchy

Nested Class Summary
static class ResourcePropertyMapping.ExcludeFromAllType
           
static class ResourcePropertyMapping.ReverseType
           
 
Method Summary
 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.
 ResourcePropertyConverter getResourcePropertyConverter()
           
 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.
 
Methods inherited from interface org.compass.core.mapping.Mapping
controlsObjectNullability, copy, getConverter, getConverterName, getName, getPath
 

Method Detail

getOriginalName

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


getAnalyzer

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


getRootAlias

String getRootAlias()
Returns the root resource mapping alias name this resource property mapping belongs to.


isInternal

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


getBoost

float getBoost()
Returns the boost level.

See Also:
Property.setBoost(float)

isOmitNorms

Boolean isOmitNorms()
Should the reosurce property omit norms or not.

See Also:
Property.setOmitNorms(boolean)

isOmitTf

Boolean isOmitTf()
Expert: If set, omit tf from postings of this indexed field.

See Also:
Property.setOmitTf(boolean)

getExcludeFromAll

ResourcePropertyMapping.ExcludeFromAllType getExcludeFromAll()

getSpellCheck

SpellCheckType getSpellCheck()

getStore

Property.Store getStore()

getIndex

Property.Index getIndex()

getTermVector

Property.TermVector getTermVector()

getReverse

ResourcePropertyMapping.ReverseType getReverse()

getNullValue

String getNullValue()

hasNullValue

boolean hasNullValue()

getResourcePropertyConverter

ResourcePropertyConverter getResourcePropertyConverter()


Copyright (c) 2004-2008 The Compass Project.