org.compass.core.mapping
Interface Mapping

All Known Subinterfaces:

AliasMapping, HasRefAliasMapping, InternalResourceMapping, InternalResourcePropertyMapping, MultipleMapping, ObjectMapping, OsemMapping, OverrideByNameMapping, ResourceMapping, ResourcePropertyMapping

All Known Implementing Classes:

AbstractAccessorMapping, AbstractAccessorMultipleMapping, AbstractCollectionMapping, AbstractMapping, AbstractMultipleMapping, AbstractRefAliasMapping, AbstractResourceMapping, AbstractResourcePropertyMapping, ArrayMapping, ClassBoostPropertyMapping, ClassIdPropertyMapping, ClassMapping, ClassPropertyAnalyzerController, ClassPropertyMapping, ClassPropertyMetaDataMapping, CollectionMapping, ComponentMapping, ConstantMetaDataMapping, ContractMapping, DynamicMetaDataMapping, IdComponentMapping, NullResourceMapping, ParentMapping, PlainCascadeMapping, RawBoostPropertyMapping, RawResourceMapping, RawResourcePropertyAnalyzerController, RawResourcePropertyIdMapping, RawResourcePropertyMapping, ReferenceMapping, XmlBoostPropertyMapping, XmlContentMapping, XmlIdMapping, XmlObjectMapping, XmlPropertyAnalyzerController, XmlPropertyMapping

public interface Mapping

A general interface for all things Mapping in compass. Has a name and a path, where the name is usually the "logical name" of the mapping, and the path is the actual name which it will be saved under in the search engine.

Also provides general support for converters attached to the mappings, which can have parameters associated with them.

Author:

kimchy

Method Summary

boolean	controlsObjectNullability() Returns true if the Mapping controlls the fact that if it has no value, it's parent might be a candidate for being nullable.
Mapping	copy() Copies over the mapping definition into a newly instanciated Mapping object.
Converter	getConverter() Returns the conveter associated with the mapping.
String	getConverterName() Returns the converter name associated with the Mapping.
String	getName() The name of the mapping.
PropertyPath	getPath() Returns the path of the mapping.
void	setConverter(Converter converter) Sets the conveter associated with the mapping.
void	setConverterName(String name) Sets the converter name associated with the Mapping.
void	setName(String name) Sets the name of the mapping.
void	setPath(PropertyPath path) Sets the path of the mapping.

Method Detail

getName

String getName()

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

setName

void setName(String name)

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

getPath

PropertyPath getPath()

Returns the path of the mapping. The path is the value under which it will be saved in the Search Engine.

setPath

void setPath(PropertyPath path)

Sets the path of the mapping. The path is the value under which it will be saved in the Search Engine.

getConverter

Converter getConverter()

Returns the conveter associated with the mapping. The converter is responsible for marshalling and unmarshalling the Mapping from and to the Search Engine.

setConverter

void setConverter(Converter converter)

Sets the conveter associated with the mapping. The converter is responsible for marshalling and unmarshalling the Mapping from and to the Search Engine.

getConverterName

String getConverterName()

Returns the converter name associated with the Mapping. The conveter name can be the actual class name of the converter, or a lookup name that has a converter associated with it.

setConverterName

void setConverterName(String name)

Sets the converter name associated with the Mapping. The conveter name can be the actual class name of the converter, or a lookup name that has a converter associated with it.

controlsObjectNullability

boolean controlsObjectNullability()

Returns true if the Mapping controlls the fact that if it has no value, it's parent might be a candidate for being nullable.

copy

Mapping copy()

Copies over the mapping definition into a newly instanciated Mapping object.