org.compass.core.mapping
Interface AliasMapping

All Superinterfaces:
Mapping, MultipleMapping
All Known Subinterfaces:
ContractMapping, InternalAliasMapping, InternalContractMapping, InternalResourceMapping, ResourceMapping
All Known Implementing Classes:
AbstractResourceMapping, ClassMapping, DefaultContractMapping, NullResourceMapping, RawResourceMapping, RootJsonObjectMapping, XmlObjectMapping

public interface AliasMapping
extends MultipleMapping

An alias mapping is a mapping that is associated with an alias.

Author:
kimchy

Method Summary
 String getAlias()
          Returns the alias this mapping is associated with.
 String getAnalyzer()
          Returns the analyzer lookup name of this alias mapping.
 String[] getExtendedAliases()
          Returns a list of aliases that this alias extends.
 String[] getExtendingAliases()
          Returns a list of all the aliases that extend this mapping.
 AliasMapping shallowCopy()
          Performs a shalow copy of this mapping, not including any internal mappings belonging to MultipleMapping.
 
Methods inherited from interface org.compass.core.mapping.MultipleMapping
getMapping, getMapping, mappingsIt
 
Methods inherited from interface org.compass.core.mapping.Mapping
controlsObjectNullability, copy, getConverter, getConverterName, getName, getPath
 

Method Detail

shallowCopy

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


getAlias

String getAlias()
Returns the alias this mapping is associated with.


getExtendedAliases

String[] getExtendedAliases()
Returns a list of aliases that this alias extends.


getExtendingAliases

String[] getExtendingAliases()
Returns a list of all the aliases that extend this mapping. Note, this is a list of all the aliases down the food chain, not just the first ones.


getAnalyzer

String getAnalyzer()
Returns the analyzer lookup name of this alias mapping.



Copyright (c) 2004-2009 The Compass Project.