Sct.Name Class Reference

Abstract class representing a the name of a persistent representation Implementations will derive a class from this. More...

Inheritance diagram for Sct.Name:

[legend]List of all members.

Public Member Functions
String	getClassName ()
	Gets the class name of the object this Name represents.
String	getUniqueID ()
	Gets the uniqueID of the object this Name represents.
abstract String	getName ()
	Gets the implementation dependant String representation of the name.
Static Public Member Functions
static String	convertToC (String className)
	Returns a className suitable for writing from a Java name.
static String	convertFromC (String className)
	Returns a Java className from a C++ style one read in.
Protected Member Functions
	Name (Serializable s)
	Construct a Name for a given Serializable Initializes the uniqueID and ClassNames.
	Name (String name) throws IllegalArgumentException
	Constructs a Name from the implementation dependant representation Calls parse.
	Name (String className, String uniqueID)
	Utility - equivalent to Name(Serializable s) given Name(s.getClassName(), s.getUniqueID());.
abstract void	parse (String name) throws IllegalArgumentException
	Should set the className and uniqueID members by parsing the implementation dependant representation.
Protected Attributes
String	uniqueID
	The UniqueID.
String	className
	The className stored in Java format.

---

Detailed Description

Abstract class representing a the name of a persistent representation Implementations will derive a class from this.

Each implementation of Name provides a string representation - for instance a filename which is contructed from information about the object to be persisted and some implementation defined way of getting e.g. the path.

For compatability with C++, the package separator is usually "::" rather than ".". This class also provides static methods to convert which implementations should use to make this transparent to the user.

Author:

Matthew Palmer

Definition at line 15 of file Name.java.

---

Member Function Documentation

String Sct.Name.getClassName (   )

Gets the class name of the object this Name represents. Returns: the Class name of the Serializable object Definition at line 35 of file Name.java. References Sct.Name.className. Referenced by Sct.IS.ObjectManagerIS.readObject(), and Sct.ISProxy.ISProxy.setFileName().

abstract String Sct.Name.getName (   )  [pure virtual]

Gets the implementation dependant String representation of the name. This can be passed to the appropriate ObjectManager for later retrieval Returns: the String representation of the Name Implemented in Sct.File.NameFile, and Sct.IS.NameIS.

String Sct.Name.getUniqueID (   )

Gets the uniqueID of the object this Name represents. Returns: the uniqueID Definition at line 43 of file Name.java. References Sct.Name.uniqueID. Referenced by Sct.ISProxy.ISProxy.setFileName().

abstract void Sct.Name.parse (  String  name  )  throws IllegalArgumentException [protected, pure virtual]

Should set the className and uniqueID members by parsing the implementation dependant representation. Parameters: name  The implementation dependant representation of the Name Implemented in Sct.File.NameFile, and Sct.IS.NameIS. Referenced by Sct.Name.Name().

---

The documentation for this class was generated from the following file:

• Name.java

---