org.portico.shared.model
Class ICMetadata

java.lang.Object
  org.portico.shared.model.ICMetadata

All Implemented Interfaces:

Serializable

public class ICMetadata
extends Object
implements Serializable

This class contains metadata information about a FOM object class

See Also:

Serialized Form

Field Summary

private Set<ICMetadata>	children
private int	handle
private String	name
private Order	order
private Map<Integer,PCMetadata>	parameters
private ICMetadata	parent
private String	qualifiedName
private static long	serialVersionUID
private Space	space
private Transport	transport
private String	vsafeQualifiedName

Constructor Summary

ICMetadata(String name, int handle)
NOTE: This constructor should generally not be used.

Method Summary

boolean	addParameter(PCMetadata parameter) Adds the given parameter to this interaction class.
Set<PCMetadata>	getAllParameters() Return a set of all available parameters for this class (inherited included)
Set<ICMetadata>	getChildTypes()
PCMetadata	getDeclaredParameter(int handle) Get the locally declared parameter (not inherited) of the given handle and return it.
Set<PCMetadata>	getDeclaredParameters() Return a set of all the parameters contained directly within this class (no inherited ones)
int	getHandle()
String	getLocalName() Get the local portion of the interaction class name.
Order	getOrder()
PCMetadata	getParameter(int handle) Get the available parameter (inherited included) of this class for the given handle.
int	getParameterHandle(String name) Return the handle of the contained parameter of the given name.
String	getParameterName(int handle) Return the name of the contained parameter of the given handle.
ICMetadata	getParent()
String	getQualifiedName() Return the fully-qualified name of this interaction class.
Space	getSpace()
Transport	getTransport()
String	getVersionSafeQualifiedName() Gets the qualified name WITHOUT InteractionRoot or HLAinteractionRoot prefixed at the front.
boolean	isRO()
boolean	isTSO()
PCMetadata	removeParameter(int handle) Remove and return the local parameter of the given handle (not inherited).
void	setOrder(Order order)
void	setParent(ICMetadata parent)
void	setSpace(Space space)
void	setTransport(Transport transport)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

name

private String name

handle

private int handle

order

private Order order

transport

private Transport transport

space

private Space space

parent

private ICMetadata parent

children

private Set<ICMetadata> children

parameters

private Map<Integer,PCMetadata> parameters

qualifiedName

private String qualifiedName

vsafeQualifiedName

private String vsafeQualifiedName

Constructor Detail

ICMetadata

public ICMetadata(String name,
                  int handle)

NOTE: This constructor should generally not be used. If you want an instance of this class you should use the creation methods of ObjectModel.

Method Detail

getChildTypes

public Set<ICMetadata> getChildTypes()

addParameter

public boolean addParameter(PCMetadata parameter)

Adds the given parameter to this interaction class. If the name of the parameter is the same as one already in this class, the request will be ignored and false will be returned. Otherwise, the parameter will be added and true will be returned.

removeParameter

public PCMetadata removeParameter(int handle)

Remove and return the local parameter of the given handle (not inherited). If there is no parameter by that handle, null will be returned.

getDeclaredParameters

public Set<PCMetadata> getDeclaredParameters()

Return a set of all the parameters contained directly within this class (no inherited ones)

getAllParameters

public Set<PCMetadata> getAllParameters()

Return a set of all available parameters for this class (inherited included)

getDeclaredParameter

public PCMetadata getDeclaredParameter(int handle)

Get the locally declared parameter (not inherited) of the given handle and return it. If there is no such parameter with that handle, return null.

getParameter

public PCMetadata getParameter(int handle)

Get the available parameter (inherited included) of this class for the given handle. If there is none for that handle (either local or inherited), null will be returned.

getParameterHandle

public int getParameterHandle(String name)

Return the handle of the contained parameter of the given name. If there is no parameter of that name in this class, ObjectModel.INVALID_HANDLE will be returned. Note: The search will include inherited parameters.

getParameterName

public String getParameterName(int handle)

Return the name of the contained parameter of the given handle. If there is no parameter of that handle in this class, null will be returned. Note: The search will include inherited parameters.

getHandle

public int getHandle()

getLocalName

public String getLocalName()

Get the local portion of the interaction class name. For example, if the qualified name was "InteractionRoot.Surface.Start", the local name would be "Start". Note that the name this class should be given on creation IS its local name only (not its fully qualified version)

getQualifiedName

public String getQualifiedName()

Return the fully-qualified name of this interaction class. This will recurse through all the parents and generate the full name.

getVersionSafeQualifiedName

public String getVersionSafeQualifiedName()

Gets the qualified name WITHOUT InteractionRoot or HLAinteractionRoot prefixed at the front. Thus, this name (while not 100% qualified) doesn't contain HLA version specific information.

getOrder

public Order getOrder()

setOrder

public void setOrder(Order order)

isRO

public boolean isRO()

isTSO

public boolean isTSO()

getParent

public ICMetadata getParent()

setParent

public void setParent(ICMetadata parent)

getTransport

public Transport getTransport()

setTransport

public void setTransport(Transport transport)

getSpace

public Space getSpace()

setSpace

public void setSpace(Space space)

toString

public String toString()

Overrides:

toString in class Object