OSRole (g9 Common 2.7.0 API)

Type Parameters:

T - the domain class of the object selection node.

All Superinterfaces:

Visitable<OSRole<?>>

All Known Implementing Classes:

AbstractOSRole
```
public interface OSRole<T>
extends Visitable<OSRole<?>>
```
Representation of a node in the object selection.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addChild(OSRole<?> child)` Adds a child to this (parent) node.
`T`	`castToType(Object obj)` If possible, returns a down-casted reference to the supplied object.
`T`	`createNewInstance()` Creates a new domain instance, using the default (empty) constructor.
`boolean`	`equalsUsingKey(Key keyToUse, Object anObject, Object anOtherObject)` Compares two domain instances using the specified key.
`AttributeConstant`	`getAttributeConstant(String attributeName)` Get the attribute constant that matches the specified attribute name.
`AttributeConstant[]`	`getAttributeConstants()` Returns an array of the attribute constants for this object selection node
`Map<AttributeConstant,Object>`	`getAttributeValues(Object domainInstance)` Gets a map of attribute values from the domain object.
`OSRole<?>`	`getChild(RoleConstant childRole)` Gets the child role for the given child role constant.
`List<OSRole<?>>`	`getChildren()` Gets an unmodifiable list of child nodes.
`Class<T>`	`getDomainClass()` Gets the domain class object.
`List<Key>`	`getKeys()` Returns the keys for this role.
`Key`	`getMainKey()` Gets the main key of the object selection role
`OSRole<?>`	`getParent()` Gets the parent of this node.
`Object`	`getRelation(Object domainObject, RoleConstant role)` Gets the specified associated relation from the domain object.
`RelationCardinality`	`getRelationCardinality()` Get the role's cardinality.
`RelationType`	`getRelationType()` Get the relation type enumeration for this role.
`RoleConstant`	`getRoleConstant()` Gets the role name of this node.
`OSRole<?>`	`getRoot()` Gets the root of this role (roots return self).
`Object`	`getValue(Object domainObject, AttributeConstant attribute)` Gets the specified attribute value from the domain object.
`Map<AttributeConstant,Object>`	`getValues(Object instance, AttributeConstant[] attributes)` Returns a map of attributes values.
`boolean`	`isAncestorOf(RoleConstant possibleHeir)` Test if this role is ancestor of `possibleHeir`.
`boolean`	`isMany()` Test if the association to this role from the parent role is a many-association.
`boolean`	`isNavigableToParent()` Returns `true` if the relation from this role to the parent is navigable.
`boolean`	`isParentMany()` Test if the association to the parent role is a many-association.
`boolean`	`isPersistent()` Test if the role is persistent.
`boolean`	`isRelated(AttributeConstant attribute)` Test if an attribute is a related attribute of this object selection role.
`boolean`	`isRoot()` Test if this is a root node.
`boolean`	`isUpRelated()` Test if this role is an up-related child.
`void`	`setMainKey(Key mainKey)` Sets the main key.
`void`	`setRelation(Object domainInstance, Object relation, RoleConstant role)` Sets the specified relation on the domain object
`void`	`setValue(Object domainObject, AttributeConstant attribute, Object value)` Sets the specified attribute value on the domain object.
`String`	`toString()` Returns the role name of this os node.
`void`	`updateRelation(Object domainInstance, Object relation, RoleConstant role)` Updates the specified relation.
`void`	`visitBranch(Visitor<OSRole<?>> visitor)` Visit this node and all child nodes (recursively).

Methods inherited from interface no.g9.support.Visitable
accept

- Method Detail
  - addChild
```
void addChild(OSRole<?> child)
```
    Adds a child to this (parent) node.
    
    Parameters:
    
    child - the child to add
    
    Throws:
    
    IllegalArgumentException - if this is not the parent of the child or the child is already added.
  - castToType
```
T castToType(Object obj)
```
    If possible, returns a down-casted reference to the supplied object. The reference is of type T.
    
    Parameters:
    
    obj - the object to downcast
    
    Returns:
    
    a casted version of the supplied object, or null if the object is not assignable to type T.
  - createNewInstance
```
T createNewInstance()
```
    Creates a new domain instance, using the default (empty) constructor.
    
    Returns:
    
    the domain instance.
  - getAttributeConstants
```
AttributeConstant[] getAttributeConstants()
```
    Returns an array of the attribute constants for this object selection node
    
    Returns:
    
    the attribute constants
  - getAttributeValues
```
Map<AttributeConstant,Object> getAttributeValues(Object domainInstance)
```
    Gets a map of attribute values from the domain object.
    
    Parameters:
    
    domainInstance - the domain instance
    
    Returns:
    
    the map of attribute values.
  - getChildren
```
List<OSRole<?>> getChildren()
```
    Gets an unmodifiable list of child nodes.
    
    Returns:
    
    the list of child nodes.
  - getChild
```
OSRole<?> getChild(RoleConstant childRole)
```
    Gets the child role for the given child role constant.
    
    Parameters:
    
    childRole - the child role constant
    
    Returns:
    
    the child role, or null if not found
  - getDomainClass
```
Class<T> getDomainClass()
```
    Gets the domain class object.
    
    Returns:
    
    the domain class object.
  - getMainKey
```
Key getMainKey()
```
    Gets the main key of the object selection role
    
    Returns:
    
    the main key
  - getParent
```
OSRole<?> getParent()
```
    Gets the parent of this node.
    
    Returns:
    
    the parent
  - getRoot
```
OSRole<?> getRoot()
```
    Gets the root of this role (roots return self).
    
    Returns:
    
    the root role of this role.
  - getKeys
```
List<Key> getKeys()
```
    Returns the keys for this role. The first key in the list is the primary key.
    
    Returns:
    
    a list of keys.
  - getRoleConstant
```
RoleConstant getRoleConstant()
```
    Gets the role name of this node.
    
    Returns:
    
    the roleName
  - getValues
```
Map<AttributeConstant,Object> getValues(Object instance,
                                        AttributeConstant[] attributes)
```
    Returns a map of attributes values. The map key is the attribute name and the value is the attribute value.
    
    Parameters:
    
    instance - the domain instance
    
    attributes - a string array of attribute names
    
    Returns:
    
    a map of attribute names and values
  - getValue
```
Object getValue(Object domainObject,
                AttributeConstant attribute)
```
    Gets the specified attribute value from the domain object.
    
    Parameters:
    
    domainObject - the domain object
    
    attribute - the constant denoting the attribute.
    
    Returns:
    
    the value
  - getRelation
```
Object getRelation(Object domainObject,
                   RoleConstant role)
```
    Gets the specified associated relation from the domain object.
    
    Parameters:
    
    domainObject - the domain object that holds the relation.
    
    role - the constant enum denoting the role.
    
    Returns:
    
    the association
  - setValue
```
void setValue(Object domainObject,
              AttributeConstant attribute,
              Object value)
```
    Sets the specified attribute value on the domain object.
    
    Parameters:
    
    domainObject - the domain object
    
    attribute - the constant denoting the attribute.
    
    value - the value to set
  - setRelation
```
void setRelation(Object domainInstance,
                 Object relation,
                 RoleConstant role)
```
    Sets the specified relation on the domain object
    
    Parameters:
    
    domainInstance - the domain object
    
    relation - the related object
    
    role - the constant denoting the relation
  - updateRelation
```
void updateRelation(Object domainInstance,
                    Object relation,
                    RoleConstant role)
```
    Updates the specified relation. If the specified role is one-related, this is the same as setRelation(Object, Object, RoleConstant). If the specified role is many-related, the relation collection is updated.
    
    Parameters:
    
    domainInstance - The relation owner.
    
    relation - the relation member.
    
    role - the role of the member relation.
  - getRelationType
```
RelationType getRelationType()
```
    Get the relation type enumeration for this role.
    
    Returns:
    
    the relation type.
  - getRelationCardinality
```
RelationCardinality getRelationCardinality()
```
    Get the role's cardinality.
    
    Returns:
    
    the cardinality enumeration of this role.
  - toString
```
String toString()
```
    Returns the role name of this os node.
    
    Overrides:
    
    toString in class Object
  - isNavigableToParent
```
boolean isNavigableToParent()
```
    Returns true if the relation from this role to the parent is navigable.
    
    Returns:
    
    true if the relation to parent is navigable.
  - setMainKey
```
void setMainKey(Key mainKey)
```
    Sets the main key.
    
    Parameters:
    
    mainKey - the mainKey to set
  - equalsUsingKey
```
boolean equalsUsingKey(Key keyToUse,
                       Object anObject,
                       Object anOtherObject)
```
    Compares two domain instances using the specified key.
    Note that both domain instances must be assignable to the type of the object selection role, otherwise a class cast exception is thrown.
    
    Parameters:
    
    keyToUse - the key to use when comparing the two instances.
    
    anObject - the first object to compare
    
    anOtherObject - the other object to compare
    
    Returns:
    
    true if all attributes in the keys are equal in both domain objects.
    
    Throws:
    
    ClassCastException - if either domain object can not be assigned to the object selection role type.
  - isAncestorOf
```
boolean isAncestorOf(RoleConstant possibleHeir)
```
    Test if this role is ancestor of possibleHeir. A role A is an ancestor of another role B if the A role can be reached by navigating up (in direction of the root) from the B role.
    
    Parameters:
    
    possibleHeir - the role that is possible a child or grand (grand..) child of this role.
    
    Returns:
    
    true if this role is an ancestor of possibleHeir.
  - isRelated
```
boolean isRelated(AttributeConstant attribute)
```
    Test if an attribute is a related attribute of this object selection role. An attribute is considered related if the attribute path contains "this" role.
    
    Parameters:
    
    attribute - the attribute to check the relation to.
    
    Returns:
    
    true if the attribute path contains "this" role.
  - isUpRelated
```
boolean isUpRelated()
```
    Test if this role is an up-related child.
    
    Returns:
    
    true if this role is up-related.
  - isParentMany
```
boolean isParentMany()
```
    Test if the association to the parent role is a many-association.
    
    Returns:
    
    true if the association to parent is many-related.
  - isPersistent
```
boolean isPersistent()
```
    Test if the role is persistent.
    
    Returns:
    
    true if the role is persistent.
  - getAttributeConstant
```
AttributeConstant getAttributeConstant(String attributeName)
```
    Get the attribute constant that matches the specified attribute name.
    
    Parameters:
    
    attributeName - the attribute name
    
    Returns:
    
    the attribute constant representing the specified attribute.
  - isMany
```
boolean isMany()
```
    Test if the association to this role from the parent role is a many-association.
    
    Returns:
    
    true if the association to this role from the parent is a many-relation.
  - isRoot
```
boolean isRoot()
```
    Test if this is a root node.
    
    Returns:
    
    true if this is a root node in the object selection tree.
  - visitBranch
```
void visitBranch(Visitor<OSRole<?>> visitor)
```
    Visit this node and all child nodes (recursively).
    
    Parameters:
    
    visitor - the visitor to visit the object selection roles.

Interface OSRole<T>

Method Summary

Methods inherited from interface no.g9.support.Visitable

Method Detail

addChild

castToType

createNewInstance

getAttributeConstants

getAttributeValues

getChildren

getChild

getDomainClass

getMainKey

getParent

getRoot

getKeys

getRoleConstant

getValues

getValue

getRelation

setValue

setRelation

updateRelation

getRelationType

getRelationCardinality

toString

isNavigableToParent

setMainKey

equalsUsingKey

isAncestorOf

isRelated

isUpRelated

isParentMany

isPersistent

getAttributeConstant

isMany

isRoot

visitBranch