org.safs.tools.input

Class UniqueStringMapInfo

java.lang.Object

org.safs.tools.UniqueStringID

org.safs.tools.input.UniqueStringMapInfo

All Implemented Interfaces:

UniqueMapInterface, UniqueIDInterface

public class UniqueStringMapInfo
extends UniqueStringID
implements UniqueMapInterface

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	mapinfo
protected java.lang.String	mappath

Fields inherited from class org.safs.tools.UniqueStringID

id

Constructor Summary

Constructors

Constructor and Description
UniqueStringMapInfo() Constructor for UniqueStringMapInfo
UniqueStringMapInfo(java.lang.String id) Constructor for UniqueStringMapInfo
UniqueStringMapInfo(java.lang.String id, java.lang.String mapinfo) PREFERRED Constructor for UniqueStringMapInfo

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getMapInfo() Get the name of the stored Map.
java.lang.Object	getMapPath(PathInterface driver) Get the full path of the specified Map.
(package private) java.lang.String	returnSetPath(java.io.File afile)
void	setMapInfo(java.lang.String mapinfo) Set the mapinfo to the String provided.

Methods inherited from class org.safs.tools.UniqueStringID

getStringID, getUniqueID, setStringID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.safs.tools.UniqueIDInterface

getUniqueID

Field Detail

mapinfo

protected java.lang.String mapinfo

mappath

protected java.lang.String mappath

Constructor Detail

UniqueStringMapInfo

public UniqueStringMapInfo()

Constructor for UniqueStringMapInfo

UniqueStringMapInfo

public UniqueStringMapInfo(java.lang.String id)

Constructor for UniqueStringMapInfo

UniqueStringMapInfo

public UniqueStringMapInfo(java.lang.String id,
                           java.lang.String mapinfo)

PREFERRED Constructor for UniqueStringMapInfo

Method Detail

setMapInfo

public void setMapInfo(java.lang.String mapinfo)

Set the mapinfo to the String provided.

getMapInfo

public java.lang.Object getMapInfo()

Description copied from interface: UniqueMapInterface

Get the name of the stored Map. It is always possible that one Map file or source is "opened" more than once with different unique IDs. The name may be a simple name, or it may be the name of a file, a fullpath to a file, or some other Object as needed by the implementation.

Specified by:

getMapInfo in interface UniqueMapInterface

See Also:

UniqueMapInterface.getMapInfo()

returnSetPath

java.lang.String returnSetPath(java.io.File afile)

getMapPath

public java.lang.Object getMapPath(PathInterface driver)

Description copied from interface: UniqueMapInterface

Get the full path of the specified Map.

Specified by:

getMapPath in interface UniqueMapInterface

Parameters:

driver - allows the object to use relative paths based on different directories (Datapool, Project, Bench).

Returns:

null if invalid source information exists.