tools.gsf.mapping

Interface MappingService

All Known Implementing Classes:

IcsMappingService

public interface MappingService

Service the read the mappings for an asset.

Since:

Apr 13, 2011

Author:

Dolf Dijkstra

Method Summary

Modifier and Type	Method and Description
Map<String,MappingValue>	readMapping(AssetIdWithSite id) Reads the mappings for the asset and the site.
AssetIdWithSite	resolveMapped(String pagename) Determine the asset (CSElement or Template) that has mapped values contained within it, given the input pagename.
AssetIdWithSite	resolveMapped(String eid, String tid, String site) Determine the asset (CSElement or Template) that has mapped values contained within it, given the input eid and tid variables.

Method Detail

resolveMapped

AssetIdWithSite resolveMapped(String pagename)

Determine the asset (CSElement or Template) that has mapped values contained within it, given the input pagename. Note that this is UNABLE to resolve a mapping that applies to an element that is called as an element from within the root element of another page.

Parameters:

pagename - the pagename, whose rootelement is either the mapped template or mapped cselement.

Returns:

the asset id and site, if found, or null

resolveMapped

AssetIdWithSite resolveMapped(String eid,
                              String tid,
                              String site)

Determine the asset (CSElement or Template) that has mapped values contained within it, given the input eid and tid variables. Note that it is expected that at most one of these two will be set at a time, and never both.

Parameters:

eid - the eid resdetails value

tid - the tid resdetails value

site - the site variable value

Returns:

the asset id and site, if found, or null

readMapping

Map<String,MappingValue> readMapping(AssetIdWithSite id)

Reads the mappings for the asset and the site.

Parameters:

id - the asset that holds the mapping.

Returns:

the mappings for the asset.