no.g9.client.support

Class RoleObject

java.lang.Object

no.g9.client.support.RoleObject

public class RoleObject
extends Object

Support class that holds information about an object and it's role.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RoleObject.AssociationAccess Class used to access a relation.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	MAX_RELATION_TYPE The maximum constant value for a relation type
protected static int	MIN_RELATION_TYPE The minimum constant value for a relation type
static int	MORE_RELATED Constant denoting a many-relation
static int	ONE_IN_MORE_RELATED Constant denoting a one - in - many relation (e.g.
static int	ONE_RELATED Constant denoting a one-relation
static int	PARENT_RELATION Constant denoting a parent-association

Constructor Summary

Constructors

Constructor and Description
RoleObject(String roleName) Instanciates a new RoleObject with the specified role name.

Method Summary

Modifier and Type	Method and Description
void	addAssociation(Object associationRoleObject, String associationName, int associationType, boolean useAccessMethod, Class paramType) Adds an association to the list of associated objects.
void	addListBlock(Object listBlock, Class[] params) Adds a list block.
void	addSimpleBlock(Object simpleBlock) Adds a simple block to the list of simple blocks that can display the domain object.
boolean	equals(Object obj) Two role objects are considered equal if they have the same role name.
RoleObject.AssociationAccess	getAssociationAccess(RoleObject associationRole) Gets the associationAcces instance used for accessing the associations on the specified role object
Iterator	getAssociationRoles() Returns an iterator with the AssociationAccess instances of this role
Set	getAssociations(Object actualObject) Returns a Set of Sets with all relations.
List	getListBlockArgs(Object domainObject, Class[] params) Internal use.
void	getListBlockArgs(Object actualObject, RoleObject roleObject, Listblock aListBlock, Class[] params, Object[] args, int curIndex) Internal use Gets a list of arguments used in reflection to access a listblock.
Class[]	getListBlockParams(Object aListBlock) Gets the set of arguments for a list block
Map	getListBlocks() Returns a list of list blocks that displays the domain object
AbstractNode	getNode() Internal use! Gets the abstract node associated with this role object.
Object	getParentDomainObject(Object childObject) Returns the parent domain instanceo of the specified child instance
List	getPathToRole(String targetRoleName) Gets the path to from this role object to the specified role object, and returns a List where each sucessive entry represents a node on the path to the target.
String	getRoleName() Returns the role name of this role
List	getSimpleBlocks() Gets the list of simple blocks that can display the domain object
int	hashCode()
boolean	hasLoopInAssociations() Detects if there is associative loop
boolean	isUpRelated() Returns true if this role is up-related.
void	setNode(AbstractNode node) Internal use! Sets the abstract node associated with this role object.
void	setUpRelated(boolean isUpRelated) Sets the up-related property.

Methods inherited from class java.lang.Object

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

Field Detail

MIN_RELATION_TYPE

protected static final int MIN_RELATION_TYPE

The minimum constant value for a relation type

See Also:

Constant Field Values

MAX_RELATION_TYPE

protected static final int MAX_RELATION_TYPE

The maximum constant value for a relation type

See Also:

Constant Field Values

ONE_RELATED

public static final int ONE_RELATED

Constant denoting a one-relation

See Also:

Constant Field Values

ONE_IN_MORE_RELATED

public static final int ONE_IN_MORE_RELATED

Constant denoting a one - in - many relation (e.g. up-related)

See Also:

Constant Field Values

MORE_RELATED

public static final int MORE_RELATED

Constant denoting a many-relation

See Also:

Constant Field Values

PARENT_RELATION

public static final int PARENT_RELATION

Constant denoting a parent-association

See Also:

Constant Field Values

Constructor Detail

RoleObject

public RoleObject(String roleName)

Instanciates a new RoleObject with the specified role name.

Parameters:

roleName - the roleName representet by this role object.

Method Detail

setNode

public void setNode(AbstractNode node)

Internal use! Sets the abstract node associated with this role object.

Parameters:

node - (missing javadoc)

getNode

public AbstractNode getNode()

Internal use! Gets the abstract node associated with this role object.

Returns:

the abstract node

addAssociation

public void addAssociation(Object associationRoleObject,
                           String associationName,
                           int associationType,
                           boolean useAccessMethod,
                           Class paramType)

Adds an association to the list of associated objects.

Parameters:

associationRoleObject - The g9 specified role name

associationName - The name of the association in the domain model

associationType - the type of association

useAccessMethod - if true, the getter and setter is used to access the association

paramType - the param type of the association.

getParentDomainObject

public Object getParentDomainObject(Object childObject)

Returns the parent domain instanceo of the specified child instance

Parameters:

childObject - the child instance

Returns:

the parent of the child instance

hasLoopInAssociations

public boolean hasLoopInAssociations()

Detects if there is associative loop

Returns:

true if there is loop

getPathToRole

public List getPathToRole(String targetRoleName)

Gets the path to from this role object to the specified role object, and returns a List where each sucessive entry represents a node on the path to the target. E.g: if the path to 'C', is A -> B -> C, and this node is 'A', the returned list contains the elements {A, B, C}, in that order. If no path exists, null is returned.

Parameters:

targetRoleName - the name of the target node

Returns:

a list of role objects representing the root to the specified target node.

getAssociations

public Set getAssociations(Object actualObject)

Returns a Set of Sets with all relations. E.g. if domain class A is associated with B and C, the set {{b1, b2, bn}, {c1, c2, cn}} is returned. Note that the set holds all associated objects, also those whose cardinality is one.

Parameters:

actualObject - (missing javadoc)

Returns:

set of associations

getRoleName

public String getRoleName()

Returns the role name of this role

Returns:

the name of this role

getAssociationAccess

public RoleObject.AssociationAccess getAssociationAccess(RoleObject associationRole)

Gets the associationAcces instance used for accessing the associations on the specified role object

Parameters:

associationRole - the association role

Returns:

the association access instance

getAssociationRoles

public Iterator getAssociationRoles()

Returns an iterator with the AssociationAccess instances of this role

Returns:

an iterator with assiciation access objects.

addListBlock

public void addListBlock(Object listBlock,
                         Class[] params)

Adds a list block.

Parameters:

listBlock - the list block

params - the parameters excepcted by the listblock line

getListBlocks

public Map getListBlocks()

Returns a list of list blocks that displays the domain object

Returns:

All listblocks that displays the domain object.

addSimpleBlock

public void addSimpleBlock(Object simpleBlock)

Adds a simple block to the list of simple blocks that can display the domain object.

Parameters:

simpleBlock - the simple block

getSimpleBlocks

public List getSimpleBlocks()

Gets the list of simple blocks that can display the domain object

Returns:

a list of simple blocks.

equals

public boolean equals(Object obj)

Two role objects are considered equal if they have the same role name.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object has the same role name as the obj argument; false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getListBlockParams

public Class[] getListBlockParams(Object aListBlock)

Gets the set of arguments for a list block

Parameters:

aListBlock - (missing javadoc)

Returns:

an array of arguments

getListBlockArgs

public List getListBlockArgs(Object domainObject,
                             Class[] params)

Internal use. Returns a list of objects that can be used in reflection code.

Parameters:

domainObject - the domain object

params - array of parameters

Returns:

the list of object arguments

getListBlockArgs

public void getListBlockArgs(Object actualObject,
                             RoleObject roleObject,
                             Listblock aListBlock,
                             Class[] params,
                             Object[] args,
                             int curIndex)

Internal use Gets a list of arguments used in reflection to access a listblock.

Parameters:

actualObject - the actual object

roleObject - the role object

aListBlock - a list block

params - the parameter array

args - the argument array

curIndex - the index of the current argument

isUpRelated

public boolean isUpRelated()

Returns true if this role is up-related.

Returns:

true if this role is up-related.

setUpRelated

public void setUpRelated(boolean isUpRelated)

Sets the up-related property.

Parameters:

isUpRelated - the value of the property.