wt.visitor
Class RoleExpandInfo

java.lang.Object
  extended bywt.visitor.RoleExpandInfo
All Implemented Interfaces:
Serializable

public class RoleExpandInfo
extends Object
implements Serializable

This class encapsulates the data necessary for navigating from a node to other nodes via association links. Roles are associated with every link. The role object is also an additional item that may be required for some navigate methods. Examples of role objects include link class and QuerySpec. The role object attribute of this class is often directly associated with a particular implementation of the Expander interface.

Supported API: true

Extendable: true

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
private  boolean reference
           
private static String RESOURCE
           
private  String role
           
private  Class roleClass
           
private  Object roleObject
           
 
Constructor Summary
RoleExpandInfo(String a_role, Class a_roleObject)
           
RoleExpandInfo(String a_role, Object a_roleObject)
          

Supported API: true
 
Method Summary
 String getRole()
          Gets the value of the attribute: role.
 Class getRoleClass()
           
 Object getRoleObject()
          Gets the value of the attribute: roleObject.
 boolean isReference()
           
private  void roleValidate(String a_Role)
           
 void setReference(boolean a_ref)
           
 void setRole(String a_Role)
          Sets the value of the attribute: role.
 void setRoleClass(Class c)
           
 void setRoleObject(Object a_RoleObject)
          Sets the value of the attribute: roleObject.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

role

private String role

roleObject

private Object roleObject

roleClass

private Class roleClass

reference

private boolean reference
Constructor Detail

RoleExpandInfo

public RoleExpandInfo(String a_role,
                      Object a_roleObject)
               throws WTPropertyVetoException


Supported API: true

Parameters:
a_role -
a_roleObject -
Throws:
WTPropertyVetoException

RoleExpandInfo

public RoleExpandInfo(String a_role,
                      Class a_roleObject)
               throws WTPropertyVetoException
Method Detail

getRole

public String getRole()
Gets the value of the attribute: role.

Supported API: true

Returns:
String

setRole

public void setRole(String a_Role)
             throws WTPropertyVetoException
Sets the value of the attribute: role.

Supported API: true

Parameters:
a_Role -
Throws:
WTPropertyVetoException

roleValidate

private void roleValidate(String a_Role)
                   throws WTPropertyVetoException
Parameters:
a_Role -
Throws:
WTPropertyVetoException

getRoleObject

public Object getRoleObject()
Gets the value of the attribute: roleObject.

Supported API: true

Returns:
Object

setRoleObject

public void setRoleObject(Object a_RoleObject)
                   throws WTPropertyVetoException
Sets the value of the attribute: roleObject.

Supported API: true

Parameters:
a_RoleObject -
Throws:
WTPropertyVetoException

getRoleClass

public Class getRoleClass()

setRoleClass

public void setRoleClass(Class c)

isReference

public boolean isReference()

setReference

public void setReference(boolean a_ref)