edu.uci.isr.xarch
Class XArchTypeMetadata

java.lang.Object
  edu.uci.isr.xarch.XArchTypeMetadata

All Implemented Interfaces:

Serializable

public class XArchTypeMetadata

extends Object

implements Serializable

See Also:

Serialized Form

Field Summary

static int	XARCH_CONTEXT XARCH_CONTEXT indicates that this type metadata describes an xArch context.
static int	XARCH_ELEMENT XARCH_ELEMENT indicates that this type metadata describes an xArch element.

Constructor Summary

XArchTypeMetadata(int type, String packageName, String typeName, XArchTypeMetadata parent, XArchPropertyMetadata[] properties, XArchActionMetadata[] actions)

Method Summary

boolean	equals(Object o)
Iterator	getActions() Returns an iterator including all actions of this XARCH_CONTEXT object.
Iterator	getActions(int typeMask) Returns an iterator including only actions of the specified type
String	getParentTypeName() Returns the type name of the parent, or null if non exists.
String	getParentTypePackage() Returns the abbreviated package name (context name) of the parent, or null if non exists.
Iterator	getProperties() Returns an ordered iterator including all properties of this XARCH_ELEMENT object.
Iterator	getProperties(int typeMask) Returns an ordered iterator including only properties of the specified type
XArchPropertyMetadata	getProperty(String name) Returns metadata describing a given property of this XARCH_ELEMENT object, or null if such a property does not exist.
List	getPropertyList() Returns a ordered list of all properties of this XARCH_ELEMENT object.
int	getType() Returns the type of object that this metadata describes.
String	getTypeName() Returns the type name used to create instances of this XARCH_ELEMENT from a context object.
String	getTypePackage() Returns the abbreviated package name (context name).
int	hashCode()
boolean	hasId() Returns true if this is an XARCH_ELEMENT object and it has an Id attribute, false otherwise.
boolean	isXArch() Returns true if this type represents the XArch type, false otherwise.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

XARCH_ELEMENT

public static final int XARCH_ELEMENT

XARCH_ELEMENT indicates that this type metadata describes an xArch element.

See Also:

Constant Field Values

XARCH_CONTEXT

public static final int XARCH_CONTEXT

XARCH_CONTEXT indicates that this type metadata describes an xArch context.

See Also:

Constant Field Values

Constructor Detail

XArchTypeMetadata

public XArchTypeMetadata(int type,
                         String packageName,
                         String typeName,
                         XArchTypeMetadata parent,
                         XArchPropertyMetadata[] properties,
                         XArchActionMetadata[] actions)

Method Detail

getType

public int getType()

Returns the type of object that this metadata describes.

Returns:

the type of object that this metadata describes.

See Also:

XARCH_ELEMENT, XARCH_CONTEXT

getTypePackage

public String getTypePackage()

Returns the abbreviated package name (context name). This name can be used to get an instance of the XARCH_CONTEXT object itself, or to get the context object from which an instance of this XARCH_ELEMENT type can be created. This may return null in the event that the XARCH_ELEMENT type being described has no abbreviated package name.

Returns:

the abbreviated package name, or null.

getTypeName

public String getTypeName()

Returns the type name used to create instances of this XARCH_ELEMENT from a context object.

Returns:

the type name used to create instances of this XARCH_ELEMENT from a context object.

getParentTypePackage

public String getParentTypePackage()

Returns the abbreviated package name (context name) of the parent, or null if non exists.

Returns:

the abbreviated package name of the parent, or null.

See Also:

getTypePackage()

getParentTypeName

public String getParentTypeName()

Returns the type name of the parent, or null if non exists.

Returns:

the type name of the parent, or null if non exists.

See Also:

getTypeName()

getProperty

public XArchPropertyMetadata getProperty(String name)

Returns metadata describing a given property of this XARCH_ELEMENT object, or null if such a property does not exist.

Parameters:

name - the name of the property to find

Returns:

metadata describing the property of the given name

getPropertyList

public List getPropertyList()

Returns a ordered list of all properties of this XARCH_ELEMENT object.

Returns:

a ordered list of all properties of this XARCH_ELEMENT object

getProperties

public Iterator getProperties()

Returns an ordered iterator including all properties of this XARCH_ELEMENT object.

Returns:

an ordered iterator including all properties of this XARCH_ELEMENT object.

getProperties

public Iterator getProperties(int typeMask)

Returns an ordered iterator including only properties of the specified type

Parameters:

typeMask - property types to include

Returns:

an ordered iterator including only properties of the specified type

hasId

public boolean hasId()

Returns true if this is an XARCH_ELEMENT object and it has an Id attribute, false otherwise.

Returns:

true if this is an XARCH_ELEMENT object and it has an Id attribute, false otherwise

isXArch

public boolean isXArch()

Returns true if this type represents the XArch type, false otherwise.

Returns:

true if this type represents the XArch type, false otherwise.

getActions

public Iterator getActions()

Returns an iterator including all actions of this XARCH_CONTEXT object.

Returns:

an iterator including all actions of this XARCH_CONTEXT object.

getActions

public Iterator getActions(int typeMask)

Returns an iterator including only actions of the specified type

Parameters:

typeMask - action types to include

Returns:

an iterator including only actions of the specified type

toString

public String toString()

equals

public boolean equals(Object o)

hashCode

public int hashCode()