NvdmAPI
Class NvdmEntity

java.lang.Object
  NvdmAPI.NvdmEntity

public class NvdmEntity

extends java.lang.Object

Class representing a record with information about objects, classes, etc. NvdmEntity objects are bundled in NvdmList containers. An NvdmEntity is used to pass back general information about an object, a class, a domain, or a file in the Radia database. That's why an NvdmEntity cannot be instantiated directly.

Version:

1.0, 6-Oct-2002

Author:

Lothar Baum

Method Summary

void	dump(java.io.PrintStream where) Dumps the contents of the entity to a stream.
java.lang.String	getAlias() Returns the entity's friendly name.
java.lang.String	getClss() Returns the name of the RCS class where this entity is stored.
java.lang.String	getDate() Returns the datestamp for this entity.
java.lang.String	getDescription() Returns the entity's description.
java.lang.String	getDomain() Returns the name of the RCS domain where this entity is stored.
java.lang.String	getFile() Returns the name of the RCS file where this entity is stored.
java.lang.String	getInstance() Returns the 32 character short name of this entity.
java.lang.String	getName() Returns the name of the entity.
java.lang.String	getObjectID() Returns this entity's unique ID.
java.lang.String	getTime() Returns the timestamp for this entity.
java.lang.String	getType() Returns a 1 character type code for this entity.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

Returns the name of the entity. For example, this can be a 32 character short name of an object (if this entity represents an object), or an 8 character short name of a class (if this entity represents a class).

Returns:

the name of the entity

getFile

public java.lang.String getFile()

Returns the name of the RCS file where this entity is stored.

Returns:

the name of the file

getDomain

public java.lang.String getDomain()

Returns the name of the RCS domain where this entity is stored.

Returns:

the name of the domain

getClss

public java.lang.String getClss()

Returns the name of the RCS class where this entity is stored. In case the entity represents the class, this returns the name of the class.

Returns:

the name of the class

getInstance

public java.lang.String getInstance()

Returns the 32 character short name of this entity. In case this entity does not represent an object (e.g., if a list of classes was requested), an empty string will be returned.

Returns:

the instance name of this entity

getAlias

public java.lang.String getAlias()

Returns the entity's friendly name. The friendly name is only returned in case this entity represents an object (i.e., a class instance) and the entity has a friendly name assigned; otherwise an empty string is returned.

Returns:

the entity's friendly name

getDescription

public java.lang.String getDescription()

Returns the entity's description. The description is only returned in case this entity represents a class; otherwise an empty string is returned.

Returns:

the entity's description

getType

public java.lang.String getType()

Returns a 1 character type code for this entity. The type code will be empty for objects (i.e., class instances); for classes, it distinguishes between transient classes (code M) and transient classes (code S).

Returns:

empty string for object, 'S' for transient classes, 'M' for persistent classes

getDate

public java.lang.String getDate()

Returns the datestamp for this entity. The format is yyyymmdd (y=year, m=month, d=day).

Returns:

the datestamp for this entity

getTime

public java.lang.String getTime()

Returns the timestamp for this entity. The format is hh:mm:ss (h=hour, m=minute, s=second).

Returns:

the timestamp for this entity

getObjectID

public java.lang.String getObjectID()

Returns this entity's unique ID. The ID is a 12 character hexadecimal code uniquely identifying the entity in the Radia database.

Returns:

the entity's unique ID

dump

public void dump(java.io.PrintStream where)

Dumps the contents of the entity to a stream. May be used for debugging purposes to see the contents of this container object.

Parameters:

where - the stream where to dump the information