Skip navigation links

oracle.stellent.wcm.core.config
Interface MappingsConfiguration

All Known Implementing Classes:

JAXBMappingsConfiguration

public interface MappingsConfiguration

Hold reference to all the available mappings

Method Summary

void	addMapping(Mapping mapping) Add a mapping; will override any mapping with the same ID
void	clearMappings() Remove all mappings
boolean	containsMapping(java.lang.String id) Return true if the ID is mapped in this config
java.util.Set<java.lang.String>	getIDs()
Mapping	getMapping(java.lang.String id) The mapping of a page name to application page
Mapping	getMappingByPath(java.lang.String path) Returns a mapping for the flie based on the path
java.util.List<Mapping>	getMappings(Mapping.Type type) Retrieve a list of mappings by type
java.util.List<Mapping>	getMappings(Mapping.Type type, java.lang.String attrName, java.lang.String attrValue) Retrieve list of mappings by type and attribute name/value match
boolean	isPathMapped(java.lang.String path) Checks to see if the path is to a file that has a mapping
void	removeMapping(java.lang.String id) Remove the mapping
java.lang.String	resolveToPath(java.lang.String id) Resolves the ID to a path

Method Detail

getIDs

java.util.Set<java.lang.String> getIDs()

Returns:

the IDs that are mapped

getMapping

Mapping getMapping(java.lang.String id)

The mapping of a page name to application page

Parameters:

id - the page name

Returns:

the mapping or null if not set

resolveToPath

java.lang.String resolveToPath(java.lang.String id)

Resolves the ID to a path

Parameters:

id - the id

Returns:

the path for the ID or null if not found

getMappings

java.util.List<Mapping> getMappings(Mapping.Type type)

Retrieve a list of mappings by type

Parameters:

type - the type

Returns:

a list of mappings of this type

getMappings

java.util.List<Mapping> getMappings(Mapping.Type type,
                                    java.lang.String attrName,
                                    java.lang.String attrValue)

Retrieve list of mappings by type and attribute name/value match

Parameters:

type - the type

attrName - the attribute name

attrValue - the value

Returns:

the mappings list

containsMapping

boolean containsMapping(java.lang.String id)

Return true if the ID is mapped in this config

Parameters:

id - the identifier

Returns:

true if the ID is mapped

removeMapping

void removeMapping(java.lang.String id)

Remove the mapping

Parameters:

id - the mapping ID

clearMappings

void clearMappings()

Remove all mappings

addMapping

void addMapping(Mapping mapping)

Add a mapping; will override any mapping with the same ID

Parameters:

mapping - the mapping object

isPathMapped

boolean isPathMapped(java.lang.String path)

Checks to see if the path is to a file that has a mapping

Parameters:

path - the Path to a file, relative to your project root

Returns:

true if the path is mapped

getMappingByPath

Mapping getMappingByPath(java.lang.String path)

Returns a mapping for the flie based on the path

Parameters:

path -

Returns:

a Mapping if one exists for the path, or null

Skip navigation links