org.compass.core.mapping.osem
Class ParentMapping

java.lang.Object
  org.compass.core.mapping.support.AbstractMapping
      org.compass.core.mapping.osem.AbstractAccessorMapping
          org.compass.core.mapping.osem.ParentMapping

All Implemented Interfaces:

CascadeMapping, InternalCascadeMapping, InternalMapping, Mapping, InternalObjectMapping, InternalOsemMapping, ObjectMapping, OsemMapping

public class ParentMapping
extends AbstractAccessorMapping
implements InternalCascadeMapping

Author:

kimchy

Nested Class Summary

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

CascadeMapping.Cascade

Constructor Summary

ParentMapping()

Method Summary

boolean	canBeCollectionWrapped() Returns true if this object mapping can be wrapped with a Collection or an Array.
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.
CascadeMapping.Cascade[]	getCascades() Returns the cascades of the mapping.
Object	getCascadeValue(Object root) Returns the value that should be cascaded basde on the root object.
void	setCascades(CascadeMapping.Cascade[] cascades) Sets the cascade mapping definitions.
boolean	shouldCascade(CascadeMapping.Cascade cascade) Returns true if cascading should be performed for the cascade parameter.
boolean	shouldCascadeCreate() Returns true if cascading should be performed for create operations.
boolean	shouldCascadeDelete() Returns true if cascading should be performed for delete operations.
boolean	shouldCascadeSave() Returns true if cascading should be performed for save operations.

Methods inherited from class org.compass.core.mapping.osem.AbstractAccessorMapping

copy, getAccessor, getDefinedInAlias, getGetter, getPropertyName, getSetter, hasAccessors, setAccessor, setDefinedInAlias, setGetter, setPropertyName, setSetter

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

copy, getConverter, getConverterName, getName, getPath, setConverter, setConverterName, setName, 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.Mapping

getConverter, getConverterName, getName, getPath

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

getConverter, getConverterName, getName, getPath

Methods inherited from interface org.compass.core.mapping.internal.InternalMapping

setConverter, setConverterName, setName, setPath

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

getConverter, getConverterName, getName, getPath

Constructor Detail

ParentMapping

public ParentMapping()

Method Detail

copy

public Mapping copy()

Description copied from interface: Mapping

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

Specified by:

copy in interface Mapping

canBeCollectionWrapped

public boolean canBeCollectionWrapped()

Description copied from interface: ObjectMapping

Returns true if this object mapping can be wrapped with a Collection or an Array.

Specified by:

canBeCollectionWrapped in interface ObjectMapping

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

Overrides:

controlsObjectNullability in class AbstractMapping

getCascades

public CascadeMapping.Cascade[] getCascades()

Description copied from interface: CascadeMapping

Returns the cascades of the mapping.

Specified by:

getCascades in interface CascadeMapping

setCascades

public void setCascades(CascadeMapping.Cascade[] cascades)

Description copied from interface: InternalCascadeMapping

Sets the cascade mapping definitions.

Specified by:

setCascades in interface InternalCascadeMapping

getCascadeValue

public Object getCascadeValue(Object root)
                       throws CompassException

Description copied from interface: CascadeMapping

Returns the value that should be cascaded basde on the root object.

Specified by:

getCascadeValue in interface CascadeMapping

Parameters:

root - The root object to extract the cascaded value from

Returns:

The cascaded value to cascade

Throws:

CompassException

shouldCascadeDelete

public boolean shouldCascadeDelete()

Description copied from interface: CascadeMapping

Returns true if cascading should be performed for delete operations.

Specified by:

shouldCascadeDelete in interface CascadeMapping

shouldCascadeCreate

public boolean shouldCascadeCreate()

Description copied from interface: CascadeMapping

Returns true if cascading should be performed for create operations.

Specified by:

shouldCascadeCreate in interface CascadeMapping

shouldCascadeSave

public boolean shouldCascadeSave()

Description copied from interface: CascadeMapping

Returns true if cascading should be performed for save operations.

Specified by:

shouldCascadeSave in interface CascadeMapping

shouldCascade

public boolean shouldCascade(CascadeMapping.Cascade cascade)

Description copied from interface: CascadeMapping

Returns true if cascading should be performed for the cascade parameter.

Specified by:

shouldCascade in interface CascadeMapping