org.safs.tools.input

Interface MapsInterface

All Known Implementing Classes:

SAFSMAPS

public interface MapsInterface

Method Summary

Modifier and Type	Method and Description
void	clearCache(UniqueIDInterface map) Clear the cache of one specific Map.
void	closeMap(UniqueIDInterface map) Close the identified Map and release all resources associated with it.
UniqueIDInterface	getDefaultMap() Get the ID of the current default map.
UniqueSectionInterface	getDefaultMapSection() Get the ID of the current default map section.
java.lang.String	getMapItem(UniqueItemInterface item) Get the value of a Mapped item.
void	openMap(UniqueMapInterface map) Open a Map and give it a unique ID.
void	setDefaultMap(UniqueIDInterface map) Set the identified Map as the default Map to be used.
void	setDefaultMapSection(UniqueSectionInterface section) Set the identified Map Section as the default Section to be used when normal lookups fail.

Method Detail

openMap

void openMap(UniqueMapInterface map)

Open a Map and give it a unique ID.

setDefaultMap

void setDefaultMap(UniqueIDInterface map)

Set the identified Map as the default Map to be used. This is set for some calls or external tools that may not always specify which Map to use. They expect the "current" or "default" Map to be referenced.

getDefaultMap

UniqueIDInterface getDefaultMap()

Get the ID of the current default map.

setDefaultMapSection

void setDefaultMapSection(UniqueSectionInterface section)

Set the identified Map Section as the default Section to be used when normal lookups fail. "ApplicationConstants" is the pre-programmed default. This allows us to change that.

getDefaultMapSection

UniqueSectionInterface getDefaultMapSection()

Get the ID of the current default map section.

getMapItem

java.lang.String getMapItem(UniqueItemInterface item)

Get the value of a Mapped item.

clearCache

void clearCache(UniqueIDInterface map)

Clear the cache of one specific Map.

See Also:

to clear the cache for ALL Maps.

closeMap

void closeMap(UniqueIDInterface map)

Close the identified Map and release all resources associated with it.