AbstractOSRole (g9 Common 2.8.1 API)

java.lang.Object
- no.g9.os.AbstractOSRole<T>

Type Parameters:

T - the domain class of the object selection node.

All Implemented Interfaces:

OSRole<T>, Visitable<OSRole<?>>
```
public abstract class AbstractOSRole<T>
extends Object
implements OSRole<T>
```
Representation of a node in the object selection.

Field Summary

Fields
Modifier and Type	Field and Description
`RelationCardinality`	`CARDINALITY` The relation cardinality of the node.
`protected List<Key>`	`keys` The list of keys.
`RelationType`	`RELATION_TYPE` The relation type.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractOSRole(OSRole<?> parent, RelationType relationType, RelationCardinality cardinality, RoleConstant roleConstant)` Constructs a new object selection role.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(Visitor<OSRole<?>> visitor)` Accept a visitor and by invoking the vistor's visit method.
`void`	`addChild(OSRole<?> child)` Adds a child to this (parent) node.
`T`	`castToType(Object obj)` If possible, returns a downcasted reference to the supplied object.
`boolean`	`equalsUsingKey(Key keyToUse, Object anObject, Object anOtherObject)` Compares two domain instances using the specified key.
`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.
`Key`	`getMainKey()` Gets the main key of the object selection role
`OSRole<?>`	`getParent()` Gets the parent of this node.
`protected Object`	`getRelatedValue(Object domainObject, AttributeConstant attribute)` Get an attribute value from a related role.
`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).
`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`	`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.
`void`	`setMainKey(Key mainKey)` Sets the main key.
`protected void`	`setRelatedValue(Object domainObject, AttributeConstant attribute, Object value)` Set an attribute value on a related role.
`String`	`toString()` Returns a string with the role name prefixed with "Role: ".
`void`	`visitBranch(Visitor<OSRole<?>> visitor)` Visit this node and all child nodes (recursively).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface no.g9.os.OSRole
createNewInstance, getAttributeConstant, getAttributeConstants, getDomainClass, getKeys, getRelation, getValue, isNavigableToParent, isParentMany, isPersistent, isUpRelated, setRelation, setValue, updateRelation

- Field Detail
  - CARDINALITY
```
public final RelationCardinality CARDINALITY
```
    The relation cardinality of the node.
  - RELATION_TYPE
```
public final RelationType RELATION_TYPE
```
    The relation type.
  - keys
```
protected List<Key> keys
```
    The list of keys. First element is always main key.
- Constructor Detail
  - AbstractOSRole
```
protected AbstractOSRole(OSRole<?> parent,
                         RelationType relationType,
                         RelationCardinality cardinality,
                         RoleConstant roleConstant)
```
    Constructs a new object selection role.
    
    Parameters:
    
    parent - the parent of this node.
    
    relationType - the type of relation to parent.
    
    cardinality - the cardinality of this node.
    
    roleConstant - the constant denoting this role.
- Method Detail
  - getRelationType
```
public RelationType getRelationType()
```
    Description copied from interface: OSRole
    
    Get the relation type enumeration for this role.
    
    Specified by:
    
    getRelationType in interface OSRole<T>
    
    Returns:
    
    the relation type.
  - getRelationCardinality
```
public RelationCardinality getRelationCardinality()
```
    Description copied from interface: OSRole
    
    Get the role's cardinality.
    
    Specified by:
    
    getRelationCardinality in interface OSRole<T>
    
    Returns:
    
    the cardinality enumeration of this role.
  - getAttributeValues
```
public Map<AttributeConstant,Object> getAttributeValues(Object domainInstance)
```
    Description copied from interface: OSRole
    
    Gets a map of attribute values from the domain object.
    
    Specified by:
    
    getAttributeValues in interface OSRole<T>
    
    Parameters:
    
    domainInstance - the domain instance
    
    Returns:
    
    the map of attribute values.
  - getParent
```
public OSRole<?> getParent()
```
    Gets the parent of this node.
    
    Specified by:
    
    getParent in interface OSRole<T>
    
    Returns:
    
    the parent
  - getRoleConstant
```
public final RoleConstant getRoleConstant()
```
    Gets the role name of this node.
    
    Specified by:
    
    getRoleConstant in interface OSRole<T>
    
    Returns:
    
    the roleName
  - getValues
```
public 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.
    
    Specified by:
    
    getValues in interface OSRole<T>
    
    Parameters:
    
    instance - the domain instance
    
    attributes - a string array of attribute names
    
    Returns:
    
    a map of attribute names and values
  - addChild
```
public void addChild(OSRole<?> child)
```
    Adds a child to this (parent) node.
    
    Specified by:
    
    addChild in interface OSRole<T>
    
    Parameters:
    
    child - the child to add
    
    Throws:
    
    IllegalArgumentException - if this is not the parent of the child or the child is already added.
  - getChildren
```
public List<OSRole<?>> getChildren()
```
    Gets an unmodifiable list of child nodes.
    
    Specified by:
    
    getChildren in interface OSRole<T>
    
    Returns:
    
    the list of child nodes.
  - getChild
```
public OSRole<?> getChild(RoleConstant childRole)
```
    Gets the child role for the given child role constant.
    
    Specified by:
    
    getChild in interface OSRole<T>
    
    Parameters:
    
    childRole - the child role constant
    
    Returns:
    
    the child role, or null if not found
  - castToType
```
public T castToType(Object obj)
```
    If possible, returns a downcasted reference to the supplied object. The reference is of type T.
    
    Specified by:
    
    castToType in interface OSRole<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.
  - toString
```
public String toString()
```
    Returns a string with the role name prefixed with "Role: ".
    
    Specified by:
    
    toString in interface OSRole<T>
    
    Overrides:
    
    toString in class Object
  - setMainKey
```
public void setMainKey(Key mainKey)
```
    Description copied from interface: OSRole
    
    Sets the main key.
    
    Specified by:
    
    setMainKey in interface OSRole<T>
    
    Parameters:
    
    mainKey - the mainKey to set
  - getMainKey
```
public Key getMainKey()
```
    Gets the main key of the object selection role
    
    Specified by:
    
    getMainKey in interface OSRole<T>
    
    Returns:
    
    the main key
  - equalsUsingKey
```
public boolean equalsUsingKey(Key keyToUse,
                              Object anObject,
                              Object anOtherObject)
```
    Description copied from interface: OSRole
    
    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.
    
    Specified by:
    
    equalsUsingKey in interface OSRole<T>
    
    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.
  - getRelatedValue
```
protected Object getRelatedValue(Object domainObject,
                                 AttributeConstant attribute)
```
    Get an attribute value from a related role. A navigation path from the given domain object to the attribute must be present in the object selection.
    
    Parameters:
    
    domainObject - the current domain object.
    
    attribute - the attribute value to get.
    
    Returns:
    
    the attribute value, or null if not found.
  - setRelatedValue
```
protected void setRelatedValue(Object domainObject,
                               AttributeConstant attribute,
                               Object value)
```
    Set an attribute value on a related role. A navigation path from the given domain object to the attribute must be present in the object selection. If a related object is missing, a default empty domain object is created.
    
    Parameters:
    
    domainObject - the current domain object.
    
    attribute - the attribute value to set.
    
    value - the new attribute value.
  - isRelated
```
public boolean isRelated(AttributeConstant attribute)
```
    Description copied from interface: OSRole
    
    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.
    
    Specified by:
    
    isRelated in interface OSRole<T>
    
    Parameters:
    
    attribute - the attribute to check the relation to.
    
    Returns:
    
    true if the attribute path contains "this" role.
  - isAncestorOf
```
public boolean isAncestorOf(RoleConstant possibleHeir)
```
    Description copied from interface: OSRole
    
    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.
    
    Specified by:
    
    isAncestorOf in interface OSRole<T>
    
    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.
  - isMany
```
public boolean isMany()
```
    Description copied from interface: OSRole
    
    Test if the association to this role from the parent role is a many-association.
    
    Specified by:
    
    isMany in interface OSRole<T>
    
    Returns:
    
    true if the association to this role from the parent is a many-relation.
  - isRoot
```
public boolean isRoot()
```
    Description copied from interface: OSRole
    
    Test if this is a root node.
    
    Specified by:
    
    isRoot in interface OSRole<T>
    
    Returns:
    
    true if this is a root node in the object selection tree.
  - getRoot
```
public OSRole<?> getRoot()
```
    Description copied from interface: OSRole
    
    Gets the root of this role (roots return self).
    
    Specified by:
    
    getRoot in interface OSRole<T>
    
    Returns:
    
    the root role of this role.
  - accept
```
public void accept(Visitor<OSRole<?>> visitor)
```
    Description copied from interface: Visitable
    
    Accept a visitor and by invoking the vistor's visit method.
    
    Specified by:
    
    accept in interface Visitable<OSRole<?>>
    
    Parameters:
    
    visitor - the visitor visiting this visitable.
    
    See Also:
    
    Visitor.visit(Object)
  - visitBranch
```
public void visitBranch(Visitor<OSRole<?>> visitor)
```
    Description copied from interface: OSRole
    
    Visit this node and all child nodes (recursively).
    
    Specified by:
    
    visitBranch in interface OSRole<T>
    
    Parameters:
    
    visitor - the visitor to visit the object selection roles.

Class AbstractOSRole<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface no.g9.os.OSRole

Field Detail

CARDINALITY

RELATION_TYPE

keys

Constructor Detail

AbstractOSRole

Method Detail

getRelationType

getRelationCardinality

getAttributeValues

getParent

getRoleConstant

getValues

addChild

getChildren

getChild

castToType

toString

setMainKey

getMainKey

equalsUsingKey

getRelatedValue

setRelatedValue

isRelated

isAncestorOf

isMany

isRoot

getRoot

accept

visitBranch