org.compass.core.mapping.xsem
Class XmlObjectMapping

java.lang.Object
  org.compass.core.mapping.AbstractMapping
      org.compass.core.mapping.AbstractMultipleMapping
          org.compass.core.mapping.AbstractResourceMapping
              org.compass.core.mapping.xsem.XmlObjectMapping

All Implemented Interfaces:

AliasMapping, Mapping, MultipleMapping, PostProcessingMapping, ResourceMapping, XPathEnabledMapping

public class XmlObjectMapping
extends AbstractResourceMapping
implements XPathEnabledMapping

Author:

kimchy

Field Summary

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

mappings, mappingsByNameMap

Constructor Summary

XmlObjectMapping()

Method Summary

int	addMapping(Mapping mapping) No duplicate names are allowed when added an id (applies the property names)
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.
XmlContentMapping	getXmlContentMapping() Returns the xml content mapping (might be null).
String	getXPath()
XmlXPathExpression	getXPathExpression()
boolean	isIncludePropertiesWithNoMappingsInAll() Returns true if when adding the different Resource properties, properties with no mappings will be added to the "all" property.
void	setXPath(String xpath)
void	setXPathExpression(XmlXPathExpression xpathExpression)
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.AbstractResourceMapping

copy, getAlias, getAllAnalyzer, getAllProperty, getAllTermVector, getAnalyzer, getAnalyzerController, getBoost, getBoostPropertyMapping, getCascadeMappings, getExtendedAliases, getExtendingAliases, getIdMappings, getResourcePropertyMapping, getResourcePropertyMappingByPath, getResourcePropertyMappings, getResourcePropertyNames, getSubIndexHash, hasSpecificAnalyzerPerResourceProperty, isAllOmitNorms, isAllSupported, isRoot, operationAllowed, postProcess, setAlias, setAllAnalyzer, setAllOmitNorms, setAllProperty, setAllSupported, setAllTermVector, setAnalyzer, setAnalyzerController, setBoost, setBoostPropertyMapping, setCascades, setExtendedAliases, setExtendingAliases, setRoot, setSubIndexHash, shallowCopy

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

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

Methods inherited from class org.compass.core.mapping.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, setConverter, setConverterName, setName, setPath

Constructor Detail

XmlObjectMapping

public XmlObjectMapping()

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

shallowCopy

public AliasMapping shallowCopy()

Description copied from interface: AliasMapping

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

Specified by:

shallowCopy in interface AliasMapping

isIncludePropertiesWithNoMappingsInAll

public boolean isIncludePropertiesWithNoMappingsInAll()

Description copied from interface: ResourceMapping

Returns true if when adding the different Resource properties, properties with no mappings will be added to the "all" property. A resoruce can have property with no mappings if it was added programtically to the resource.

Specified by:

isIncludePropertiesWithNoMappingsInAll in interface ResourceMapping

addMapping

public int addMapping(Mapping mapping)

Description copied from class: AbstractResourceMapping

No duplicate names are allowed when added an id (applies the property names)

Specified by:

addMapping in interface MultipleMapping

Overrides:

addMapping in class AbstractResourceMapping

Parameters:

mapping - The mapping to add

Returns:

The location the mapping was added to.

doPostProcess

protected void doPostProcess()
                      throws MappingException

Specified by:

doPostProcess in class AbstractResourceMapping

Throws:

MappingException

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.

Specified by:

getResourcePropertyMappingByDotPath in interface ResourceMapping

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).

Specified by:

getResourcePropertyMappings in interface ResourceMapping

getXPath

public String getXPath()

Specified by:

getXPath in interface XPathEnabledMapping

setXPath

public void setXPath(String xpath)

getXPathExpression

public XmlXPathExpression getXPathExpression()

Specified by:

getXPathExpression in interface XPathEnabledMapping

setXPathExpression

public void setXPathExpression(XmlXPathExpression xpathExpression)

Specified by:

setXPathExpression in interface XPathEnabledMapping

getXmlContentMapping

public XmlContentMapping getXmlContentMapping()

Returns the xml content mapping (might be null).