| org.compass.core.mapping.Mapping
All known Subclasses: org.compass.core.mapping.AbstractMapping,
Mapping | public interface Mapping (Code) | | 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 |
controlsObjectNullability | boolean controlsObjectNullability()(Code) | | 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()(Code) | | Copies over the mapping definition into a newly instanciated Mapping object.
|
getConverter | Converter getConverter()(Code) | | Returns 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()(Code) | | 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.
|
getName | String getName()(Code) | | The name of the mapping. Acts as the "logical" name of the mapping (think
Java Bean Property name).
|
getPath | PropertyPath getPath()(Code) | | Returns the path of the mapping. The path is the value under which it will
be saved in the Search Engine.
|
setConverter | void setConverter(Converter converter)(Code) | | Sets the conveter associated with the mapping. The converter is responsible for
marshalling and unmarshalling the Mapping from and to the Search Engine.
|
setConverterName | void setConverterName(String name)(Code) | | 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.
|
setName | void setName(String name)(Code) | | Sets the name of the mapping. Acts as the "logical" name of the mapping (think
Java Bean Property name).
|
setPath | void setPath(PropertyPath path)(Code) | | Sets the path of the mapping. The path is the value under which it will
be saved in the Search Engine.
|
|
|