org.compass.core.mapping
Class AbstractMapping

java.lang.Object
  extended by org.compass.core.mapping.AbstractMapping
All Implemented Interfaces:
Mapping
Direct Known Subclasses:
AbstractAccessorMapping, AbstractMultipleMapping, AbstractResourcePropertyMapping

public abstract class AbstractMapping
extends Object
implements Mapping

Author:
kimchy

Constructor Summary
AbstractMapping()
           
 
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.
protected  void copy(Mapping copy)
           
 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 converterName)
          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.
 
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.Mapping
copy
 

Constructor Detail

AbstractMapping

public AbstractMapping()
Method Detail

copy

protected void copy(Mapping copy)

controlsObjectNullability

public boolean controlsObjectNullability()
Description copied from interface: Mapping
Returns true if the Mapping controlls the fact that if it has no value, it's parent might be a candidate for being nullable.

Specified by:
controlsObjectNullability in interface Mapping

getConverter

public Converter getConverter()
Description copied from interface: Mapping
Returns the conveter associated with the mapping. The converter is responsible for marshalling and unmarshalling the Mapping from and to the Search Engine.

Specified by:
getConverter in interface Mapping

setConverter

public void setConverter(Converter converter)
Description copied from interface: Mapping
Sets the conveter associated with the mapping. The converter is responsible for marshalling and unmarshalling the Mapping from and to the Search Engine.

Specified by:
setConverter in interface Mapping

getName

public String getName()
Description copied from interface: Mapping
The name of the mapping. Acts as the "logical" name of the mapping (think Java Bean Property name).

Specified by:
getName in interface Mapping

setName

public void setName(String name)
Description copied from interface: Mapping
Sets the name of the mapping. Acts as the "logical" name of the mapping (think Java Bean Property name).

Specified by:
setName in interface Mapping

getPath

public PropertyPath getPath()
Description copied from interface: Mapping
Returns the path of the mapping. The path is the value under which it will be saved in the Search Engine.

Specified by:
getPath in interface Mapping

setPath

public void setPath(PropertyPath path)
Description copied from interface: Mapping
Sets the path of the mapping. The path is the value under which it will be saved in the Search Engine.

Specified by:
setPath in interface Mapping

getConverterName

public String getConverterName()
Description copied from interface: Mapping
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.

Specified by:
getConverterName in interface Mapping

setConverterName

public void setConverterName(String converterName)
Description copied from interface: Mapping
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.

Specified by:
setConverterName in interface Mapping


Copyright (c) 2004-2008 The Compass Project.