org.compass.core.mapping.support
Class NullResourceMapping

java.lang.Object
  org.compass.core.mapping.support.AbstractMapping
      org.compass.core.mapping.support.AbstractMultipleMapping
          org.compass.core.mapping.support.AbstractResourceMapping
              org.compass.core.mapping.support.NullResourceMapping

All Implemented Interfaces:

AliasMapping, InternalAliasMapping, InternalMapping, InternalMultipleMapping, InternalResourceMapping, PostProcessingMapping, Mapping, MultipleMapping, ResourceMapping

public class NullResourceMapping
extends AbstractResourceMapping

A helper resource mapping class that marks the resource mapping as null (i.e. no resource mapping for you!).

Author:

kimchy

Field Summary

Fields inherited from class org.compass.core.mapping.support.AbstractMultipleMapping

mappings, mappingsByNameMap

Constructor Summary

NullResourceMapping()

Method Summary

Mapping	copy() Copies over the mapping definition into a newly instanciated Mapping object.
protected void	doPostProcess()
ResourcePropertyMapping	getResourcePropertyMappingByDotPath(String path) Returns the ResourcePropertyMapping that match the given path "dot" path (a.bValue.value), or null if none exists.
ResourcePropertyMapping[]	getResourcePropertyMappings() Returns all the resource property mappings that are assoicated with the resource mapping.
AliasMapping	shallowCopy() Performs a shalow copy of this mapping, not including any internal mappings belonging to MultipleMapping.

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

addMapping, copy, getAlias, getAllMapping, getAnalyzer, getAnalyzerController, getBoost, getBoostPropertyMapping, getCascadeMappings, getExtendedAliases, getExtendingAliases, getIdMappings, getResourceIdMappings, getResourcePropertyMapping, getResourcePropertyMappingByPath, getResourcePropertyMappings, getResourcePropertyNames, getSpellCheck, getSubIndexHash, getUIDPath, hasSpecificAnalyzerPerResourceProperty, isRoot, operationAllowed, postProcess, setAlias, setAllMapping, setAnalyzer, setAnalyzerController, setBoost, setBoostPropertyMapping, setCascades, setExtendedAliases, setExtendingAliases, setRoot, setSpellCheck, setSubIndexHash, setUIDPath, shallowCopy

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

addMappings, clearMappings, copy, getMapping, getMapping, mappingsIt, mappingsSize, removeExistingByName, replaceMappings, shallowCopy

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

controlsObjectNullability, 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.MultipleMapping

getMapping, getMapping, mappingsIt

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

controlsObjectNullability, getConverter, getConverterName, getName, getPath

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

getMapping, getMapping, mappingsIt

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

controlsObjectNullability, getConverter, getConverterName, getName, getPath

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

getMapping, getMapping, mappingsIt

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

controlsObjectNullability, 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

controlsObjectNullability, getConverter, getConverterName, getName, getPath

Constructor Detail

NullResourceMapping

public NullResourceMapping()

Method Detail

doPostProcess

protected void doPostProcess()
                      throws MappingException

Specified by:

doPostProcess in class AbstractResourceMapping

Throws:

MappingException

copy

public Mapping copy()

Description copied from interface: Mapping

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

shallowCopy

public AliasMapping shallowCopy()

Description copied from interface: AliasMapping

Performs a shalow copy of this mapping, not including any internal mappings belonging to MultipleMapping.

getResourcePropertyMappings

public ResourcePropertyMapping[] getResourcePropertyMappings()

Description copied from interface: ResourceMapping

Returns all the resource property mappings that are assoicated with the resource mapping. Note, that it is an important method, since it might be that not all the mappings that were added to the resource mapping are of type ResourcePropertyMapping, and using this method you can be assured that ALL the ResourcePropertyMappings will be returned (even deep ones).

getResourcePropertyMappingByDotPath

public ResourcePropertyMapping getResourcePropertyMappingByDotPath(String path)

Description copied from interface: ResourceMapping

Returns the ResourcePropertyMapping that match the given path "dot" path (a.bValue.value), or null if none exists.