RelationImpl (Tentackle Data Model 2.0.4 API)

java.lang.Object
- org.tentackle.model.impl.RelationImpl

All Implemented Interfaces:

Comparable<RelationImpl>, Relation
```
public class RelationImpl
extends Object
implements Relation, Comparable<RelationImpl>
```
Relation implementation.

Author:

harald

Constructor Summary

Constructors
Constructor and Description

RelationImpl(Entity entity, SourceInfo sourceInfo)
Creates a relation.

Constructors
Constructor and Description
`RelationImpl(Entity entity, SourceInfo sourceInfo)` Creates a relation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(RelationImpl o)`
`ModelException`	`createModelException(String message)` Creates a model exception.
`boolean`	`equals(Object obj)`
`AccessScope`	`getAccessScope()` Gets the access scope for generated methods.
`List<String>`	`getAnnotations()` list of annotations.
`Attribute`	`getAttribute()` Gets the associated attribute.
`String`	`getClassName()` Gets the name of the related class.
`String`	`getComment()` Gets the comment.
`String`	`getDeclaredJavaType()` Gets the declared java type of the relation.
`Relation`	`getDefiningNmRelation()` Gets the relation of the entity defining the nm-relation.
`Entity`	`getEntity()` Gets the entity this relation belongs to.
`Attribute`	`getForeignAttribute()` Gets the foreign attribute.
`Entity`	`getForeignEntity()` Gets the related entity.
`Relation`	`getForeignRelation()` Gets the foreign (opposite) relation.
`String`	`getGetterName()` Gets the getter method name.
`String`	`getGetterSetterComment()` Gets the comment line for getter and setter.
`String`	`getJavaType()` Gets the effective java type of the relation.
`String`	`getLinkMethodIndex()` Returns the optional link method index parameter.
`String`	`getLinkMethodName()` Gets the name for the link method.
`List<String>`	`getMethodArgs()` Gets the method arguments for select- and delete-methods.
`String`	`getMethodName()` Gets the name-part for select- and delete-methods.
`String`	`getMethodNameSuffix()` Gets the suffix to be used in methodnames.
`String`	`getName()` Gets the name of this relation. By default the name is the className with the first character in lowercase.
`String`	`getNmMethodName()` Same as `Relation.getMethodName()` but for nm relation.
`String`	`getNmName()` Gets the name of the nm-relation.
`Relation`	`getNmRelation()` Gets the N:M relation of the foreign entity.
`RelationType`	`getRelationType()` Gets the relation type.
`SelectionType`	`getSelectionType()` Gets the selection type.
`String`	`getSelectionWurbletArguments()` Gets the optional wurblet arguments. Only available for composite list relations.
`String`	`getSetterName()` Gets the setter method name.
`RelationLine`	`getSourceLine()` Gets the source line.
`String`	`getVariableName()` Gets the variable name.
`int`	`hashCode()`
`boolean`	`isClearOnRemoteSave()` Returns whether the relation should be cleared before save. Used for non-composite serialized relations that should not be transmitted to the server.
`boolean`	`isComposite()` Returns whether the relation points to components of a composite.
`boolean`	`isDeepReference()` Returns whether this relation is a deep reference. Deep references point to components of another composite entity.
`boolean`	`isDeletionCascaded()` Returns whether deletion is cascaded to elements in lists.
`boolean`	`isDeletionFromMainClass()` Returns whether delete method is invoked on main class instead of relation class.
`boolean`	`isProcessed()` Returns whether a process-method is invoked after initialization, select and before save. The method has the same name as the getter with "get" replaced by "process" and must be provided by the application. This flag applies to composite relations only.
`boolean`	`isReadOnly()` Returns whether the relation is read only.
`boolean`	`isReferenced()` Returns whether the parent object is referenced by a variable.
`boolean`	`isReversed()` Returns whether this is list relation with only one element. A.k.a.
`boolean`	`isSelectionCached()` Returns whether the select method is a caching one.
`boolean`	`isSelectionFromMainClass()` Returns whether select method is invoked on main class instead of relation class.
`boolean`	`isSerialized()` Returns whether the relation is serialized. Used for non-composite relations to make them non-transient.
`boolean`	`isTracked()` Returns whether the modification state of the relation is available.
`boolean`	`isWriteOnly()` Returns whether the relation is write-only.
`void`	`parse(Entity entity, RelationLine line)` Parses a relation line.
`void`	`setAccessScope(AccessScope accessScope)`
`void`	`setAnnotations(List<String> annotations)`
`void`	`setAttribute(Attribute attribute)`
`void`	`setClassName(String className)`
`void`	`setClearOnRemoteSave(boolean clearOnRemoteSave)`
`void`	`setComment(String comment)`
`void`	`setComposite(boolean composite)`
`void`	`setDeepReference(boolean deepReference)`
`void`	`setDefiningNmRelation(Relation definingNmRelation)`
`void`	`setDeletionCascaded(boolean deletionCascaded)`
`void`	`setDeletionFromMainClass(boolean deletionFromMainClass)`
`void`	`setForeignAttribute(Attribute foreignAttribute)`
`void`	`setForeignEntity(Entity foreignEntity)`
`void`	`setForeignRelation(Relation foreignRelation)`
`void`	`setLinkMethodIndex(String linkMethodIndex)`
`void`	`setLinkMethodName(String linkMethodName)`
`void`	`setMethodArgs(List<String> methodArgs)`
`void`	`setMethodName(String methodName)`
`void`	`setName(String name)`
`void`	`setNmMethodName(String nmMethodName)`
`void`	`setNmName(String nmName)`
`void`	`setNmRelation(Relation nmRelation)`
`void`	`setProcessed(boolean processed)`
`void`	`setReadOnly(boolean readOnly)`
`void`	`setReferenced(boolean referenced)`
`void`	`setRelationType(RelationType relationType)`
`void`	`setReversed(boolean reversed)`
`void`	`setSelectionCached(boolean selectionCached)`
`void`	`setSelectionFromMainClass(boolean selectionFromMainClass)`
`void`	`setSelectionType(SelectionType selectionType)`
`void`	`setSelectionWurbletArguments(String selectionWurbletArguments)`
`void`	`setSerialized(boolean serialized)`
`void`	`setSourceLine(RelationLine sourceLine)`
`void`	`setTracked(boolean tracked)`
`void`	`setWriteOnly(boolean writeOnly)`
`String`	`toString()`
`void`	`validate()` Validates the relation.

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

- Constructor Detail
  - RelationImpl
```
public RelationImpl(Entity entity,
                    SourceInfo sourceInfo)
```
    Creates a relation.
    
    Parameters:
    
    entity - the entity this relation belongs to
    
    sourceInfo - the source info
- Method Detail
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - compareTo
```
public int compareTo(RelationImpl o)
```
    Specified by:
    
    compareTo in interface Comparable<RelationImpl>
  - parse
```
public void parse(Entity entity,
                  RelationLine line)
           throws ModelException
```
    Parses a relation line.
    
    Parameters:
    
    entity - the entity
    
    line - the source line
    
    Throws:
    
    ModelException - if parsing the model failed
  - getEntity
```
public Entity getEntity()
```
    Description copied from interface: Relation
    
    Gets the entity this relation belongs to.
    
    Specified by:
    
    getEntity in interface Relation
    
    Returns:
    
    the entity
  - getAnnotations
```
public List<String> getAnnotations()
```
    Description copied from interface: Relation
    
    list of annotations.
    
    Specified by:
    
    getAnnotations in interface Relation
    
    Returns:
    
    the annotations
  - setAnnotations
```
public void setAnnotations(List<String> annotations)
```
  - getGetterSetterComment
```
public String getGetterSetterComment()
```
    Description copied from interface: Relation
    
    Gets the comment line for getter and setter.
    
    Specified by:
    
    getGetterSetterComment in interface Relation
    
    Returns:
    
    the comment
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - validate
```
public void validate()
              throws ModelException
```
    Description copied from interface: Relation
    
    Validates the relation.
    
    Specified by:
    
    validate in interface Relation
    
    Throws:
    
    ModelException - if validation failed
  - getName
```
public String getName()
```
    Description copied from interface: Relation
    
    Gets the name of this relation.
    By default the name is the className with the first character in lowercase.
    
    Specified by:
    
    getName in interface Relation
    
    Returns:
    
    the name
  - setName
```
public void setName(String name)
```
  - getSourceLine
```
public RelationLine getSourceLine()
```
    Description copied from interface: Relation
    
    Gets the source line.
    
    Specified by:
    
    getSourceLine in interface Relation
    
    Returns:
    
    the source line
  - setSourceLine
```
public void setSourceLine(RelationLine sourceLine)
```
  - createModelException
```
public ModelException createModelException(String message)
```
    Creates a model exception.
    Refers to the source line if set, otherwise just the message.
    
    Parameters:
    
    message - the message
    
    Returns:
    
    the exception
  - getComment
```
public String getComment()
```
    Description copied from interface: Relation
    
    Gets the comment.
    
    Specified by:
    
    getComment in interface Relation
    
    Returns:
    
    the comment
  - getClassName
```
public String getClassName()
```
    Description copied from interface: Relation
    
    Gets the name of the related class.
    
    Specified by:
    
    getClassName in interface Relation
    
    Returns:
    
    the classname
  - getRelationType
```
public RelationType getRelationType()
```
    Description copied from interface: Relation
    
    Gets the relation type.
    
    Specified by:
    
    getRelationType in interface Relation
    
    Returns:
    
    list or object
  - getAccessScope
```
public AccessScope getAccessScope()
```
    Description copied from interface: Relation
    
    Gets the access scope for generated methods.
    
    Specified by:
    
    getAccessScope in interface Relation
    
    Returns:
    
    the scope
  - getAttribute
```
public Attribute getAttribute()
```
    Description copied from interface: Relation
    
    Gets the associated attribute.
    
    Specified by:
    
    getAttribute in interface Relation
    
    Returns:
    
    the attribute, null if ID of foreign entity
  - getForeignEntity
```
public Entity getForeignEntity()
```
    Description copied from interface: Relation
    
    Gets the related entity.
    
    Specified by:
    
    getForeignEntity in interface Relation
    
    Returns:
    
    the foreign entity
  - getForeignAttribute
```
public Attribute getForeignAttribute()
```
    Description copied from interface: Relation
    
    Gets the foreign attribute.
    
    Specified by:
    
    getForeignAttribute in interface Relation
    
    Returns:
    
    the attribute, null if ID of this entity
  - getForeignRelation
```
public Relation getForeignRelation()
```
    Description copied from interface: Relation
    
    Gets the foreign (opposite) relation.
    
    Specified by:
    
    getForeignRelation in interface Relation
    
    Returns:
    
    the foreign relation, null if no such relation
  - getNmRelation
```
public Relation getNmRelation()
```
    Description copied from interface: Relation
    
    Gets the N:M relation of the foreign entity.
    
    Specified by:
    
    getNmRelation in interface Relation
    
    Returns:
    
    the nm-relation, null if this is no nm-relation
  - getDefiningNmRelation
```
public Relation getDefiningNmRelation()
```
    Description copied from interface: Relation
    
    Gets the relation of the entity defining the nm-relation.
    
    Specified by:
    
    getDefiningNmRelation in interface Relation
    
    Returns:
    
    the defining relation
  - isComposite
```
public boolean isComposite()
```
    Description copied from interface: Relation
    
    Returns whether the relation points to components of a composite.
    
    Specified by:
    
    isComposite in interface Relation
    
    Returns:
    
    true if composite relation
  - isTracked
```
public boolean isTracked()
```
    Description copied from interface: Relation
    
    Returns whether the modification state of the relation is available.
    
    Specified by:
    
    isTracked in interface Relation
    
    Returns:
    
    true if tracked object or tracked list
  - isReferenced
```
public boolean isReferenced()
```
    Description copied from interface: Relation
    
    Returns whether the parent object is referenced by a variable.
    
    Specified by:
    
    isReferenced in interface Relation
    
    Returns:
    
    true if referenced
  - isProcessed
```
public boolean isProcessed()
```
    Description copied from interface: Relation
    
    Returns whether a process-method is invoked after initialization, select and before save.
    The method has the same name as the getter with "get" replaced by "process" and must be provided by the application.
    This flag applies to composite relations only.
    
    Specified by:
    
    isProcessed in interface Relation
    
    Returns:
    
    true if processed
  - isReadOnly
```
public boolean isReadOnly()
```
    Description copied from interface: Relation
    
    Returns whether the relation is read only.
    
    Specified by:
    
    isReadOnly in interface Relation
    
    Returns:
    
    true if no setter method
  - isWriteOnly
```
public boolean isWriteOnly()
```
    Description copied from interface: Relation
    
    Returns whether the relation is write-only.
    
    Specified by:
    
    isWriteOnly in interface Relation
    
    Returns:
    
    true if no getter method
  - isSerialized
```
public boolean isSerialized()
```
    Description copied from interface: Relation
    
    Returns whether the relation is serialized.
    Used for non-composite relations to make them non-transient.
    
    Specified by:
    
    isSerialized in interface Relation
    
    Returns:
    
    true if serialized, false if transient
  - isClearOnRemoteSave
```
public boolean isClearOnRemoteSave()
```
    Description copied from interface: Relation
    
    Returns whether the relation should be cleared before save.
    Used for non-composite serialized relations that should not be transmitted to the server.
    
    Specified by:
    
    isClearOnRemoteSave in interface Relation
    
    Returns:
    
    true if transient on save
  - isReversed
```
public boolean isReversed()
```
    Description copied from interface: Relation
    
    Returns whether this is list relation with only one element.
    A.k.a. reversed 1:1 object relation.
    
    Specified by:
    
    isReversed in interface Relation
    
    Returns:
    
    true if reversed
  - getMethodName
```
public String getMethodName()
```
    Description copied from interface: Relation
    
    Gets the name-part for select- and delete-methods.
    
    Specified by:
    
    getMethodName in interface Relation
    
    Returns:
    
    the method name, null if default from foreign entity name
  - getMethodArgs
```
public List<String> getMethodArgs()
```
    Description copied from interface: Relation
    
    Gets the method arguments for select- and delete-methods.
    
    Specified by:
    
    getMethodArgs in interface Relation
    
    Returns:
    
    the args
  - getNmName
```
public String getNmName()
```
    Description copied from interface: Relation
    
    Gets the name of the nm-relation.
    
    Specified by:
    
    getNmName in interface Relation
    
    Returns:
    
    the n:m relation name, null if this is not an n:m-relation
  - getNmMethodName
```
public String getNmMethodName()
```
    Description copied from interface: Relation
    
    Same as Relation.getMethodName() but for nm relation.
    
    Specified by:
    
    getNmMethodName in interface Relation
    
    Returns:
    
    the list method name, null if default
  - getLinkMethodName
```
public String getLinkMethodName()
```
    Description copied from interface: Relation
    
    Gets the name for the link method.
    
    Specified by:
    
    getLinkMethodName in interface Relation
    
    Returns:
    
    the link method, null if default
  - getLinkMethodIndex
```
public String getLinkMethodIndex()
```
    Description copied from interface: Relation
    
    Returns the optional link method index parameter.
    
    Specified by:
    
    getLinkMethodIndex in interface Relation
    
    Returns:
    
    the index parameter, null if no index
  - getSelectionType
```
public SelectionType getSelectionType()
```
    Description copied from interface: Relation
    
    Gets the selection type.
    
    Specified by:
    
    getSelectionType in interface Relation
    
    Returns:
    
    the selection tupe
  - isSelectionFromMainClass
```
public boolean isSelectionFromMainClass()
```
    Description copied from interface: Relation
    
    Returns whether select method is invoked on main class instead of relation class.
    
    Specified by:
    
    isSelectionFromMainClass in interface Relation
    
    Returns:
    
    true if select from main class
  - isSelectionCached
```
public boolean isSelectionCached()
```
    Description copied from interface: Relation
    
    Returns whether the select method is a caching one.
    
    Specified by:
    
    isSelectionCached in interface Relation
    
    Returns:
    
    true if cached
  - getSelectionWurbletArguments
```
public String getSelectionWurbletArguments()
```
    Description copied from interface: Relation
    
    Gets the optional wurblet arguments.
    Only available for composite list relations.
    
    Specified by:
    
    getSelectionWurbletArguments in interface Relation
    
    Returns:
    
    the extra wurblet args
  - isDeletionFromMainClass
```
public boolean isDeletionFromMainClass()
```
    Description copied from interface: Relation
    
    Returns whether delete method is invoked on main class instead of relation class.
    
    Specified by:
    
    isDeletionFromMainClass in interface Relation
    
    Returns:
    
    true if delete from main class
  - isDeletionCascaded
```
public boolean isDeletionCascaded()
```
    Description copied from interface: Relation
    
    Returns whether deletion is cascaded to elements in lists.
    
    Specified by:
    
    isDeletionCascaded in interface Relation
    
    Returns:
    
    true if cascaded
  - setNmRelation
```
public void setNmRelation(Relation nmRelation)
```
  - setDefiningNmRelation
```
public void setDefiningNmRelation(Relation definingNmRelation)
```
  - setAttribute
```
public void setAttribute(Attribute attribute)
```
  - setForeignEntity
```
public void setForeignEntity(Entity foreignEntity)
```
  - setForeignAttribute
```
public void setForeignAttribute(Attribute foreignAttribute)
```
  - setForeignRelation
```
public void setForeignRelation(Relation foreignRelation)
```
  - setClassName
```
public void setClassName(String className)
```
  - setComment
```
public void setComment(String comment)
```
  - setComposite
```
public void setComposite(boolean composite)
```
  - setLinkMethodName
```
public void setLinkMethodName(String linkMethodName)
```
  - setMethodArgs
```
public void setMethodArgs(List<String> methodArgs)
```
  - setNmName
```
public void setNmName(String nmName)
```
  - setNmMethodName
```
public void setNmMethodName(String nmMethodName)
```
  - setMethodName
```
public void setMethodName(String methodName)
```
  - setReadOnly
```
public void setReadOnly(boolean readOnly)
```
  - setReferenced
```
public void setReferenced(boolean referenced)
```
  - setProcessed
```
public void setProcessed(boolean processed)
```
  - setRelationType
```
public void setRelationType(RelationType relationType)
```
  - setSerialized
```
public void setSerialized(boolean serialized)
```
  - setClearOnRemoteSave
```
public void setClearOnRemoteSave(boolean clearOnRemoteSave)
```
  - setReversed
```
public void setReversed(boolean reversed)
```
  - setTracked
```
public void setTracked(boolean tracked)
```
  - setWriteOnly
```
public void setWriteOnly(boolean writeOnly)
```
  - setSelectionType
```
public void setSelectionType(SelectionType selectionType)
```
  - setSelectionCached
```
public void setSelectionCached(boolean selectionCached)
```
  - setSelectionFromMainClass
```
public void setSelectionFromMainClass(boolean selectionFromMainClass)
```
  - setSelectionWurbletArguments
```
public void setSelectionWurbletArguments(String selectionWurbletArguments)
```
  - setAccessScope
```
public void setAccessScope(AccessScope accessScope)
```
  - setDeletionCascaded
```
public void setDeletionCascaded(boolean deletionCascaded)
```
  - setDeletionFromMainClass
```
public void setDeletionFromMainClass(boolean deletionFromMainClass)
```
  - setLinkMethodIndex
```
public void setLinkMethodIndex(String linkMethodIndex)
```
  - getVariableName
```
public String getVariableName()
```
    Gets the variable name.
    
    Specified by:
    
    getVariableName in interface Relation
    
    Returns:
    
    the variable name
  - getMethodNameSuffix
```
public String getMethodNameSuffix()
```
    Gets the suffix to be used in methodnames.
    Example:
```
  "set" + getMethodNameSuffix() would return "setBlah" if the
  classname is "Blah" or the name is "blah".
 
```
    Specified by:
    
    getMethodNameSuffix in interface Relation
    
    Returns:
    
    the suffix
  - getGetterName
```
public String getGetterName()
```
    Description copied from interface: Relation
    
    Gets the getter method name.
    
    Specified by:
    
    getGetterName in interface Relation
    
    Returns:
    
    the getter
  - getSetterName
```
public String getSetterName()
```
    Description copied from interface: Relation
    
    Gets the setter method name.
    
    Specified by:
    
    getSetterName in interface Relation
    
    Returns:
    
    the setter
  - getDeclaredJavaType
```
public String getDeclaredJavaType()
```
    Description copied from interface: Relation
    
    Gets the declared java type of the relation.
    
    Specified by:
    
    getDeclaredJavaType in interface Relation
    
    Returns:
    
    the declared java type
  - getJavaType
```
public String getJavaType()
```
    Description copied from interface: Relation
    
    Gets the effective java type of the relation.
    Example: the effective type is ArrayList and the declared type is List.
    
    Specified by:
    
    getJavaType in interface Relation
    
    Returns:
    
    the effective java type
  - isDeepReference
```
public boolean isDeepReference()
```
    Description copied from interface: Relation
    
    Returns whether this relation is a deep reference.
    Deep references point to components of another composite entity.
    
    Specified by:
    
    isDeepReference in interface Relation
    
    Returns:
    
    true if deep reference
  - setDeepReference
```
public void setDeepReference(boolean deepReference)
```

Class RelationImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RelationImpl

Method Detail

hashCode

equals

compareTo

parse

getEntity

getAnnotations

setAnnotations

getGetterSetterComment

toString

validate

getName

setName

getSourceLine

setSourceLine

createModelException

getComment

getClassName

getRelationType

getAccessScope

getAttribute

getForeignEntity

getForeignAttribute

getForeignRelation

getNmRelation

getDefiningNmRelation

isComposite

isTracked

isReferenced

isProcessed

isReadOnly

isWriteOnly

isSerialized

isClearOnRemoteSave

isReversed

getMethodName

getMethodArgs

getNmName

getNmMethodName

getLinkMethodName

getLinkMethodIndex

getSelectionType

isSelectionFromMainClass

isSelectionCached

getSelectionWurbletArguments

isDeletionFromMainClass

isDeletionCascaded

setNmRelation

setDefiningNmRelation

setAttribute

setForeignEntity

setForeignAttribute

setForeignRelation

setClassName

setComment

setComposite

setLinkMethodName

setMethodArgs

setNmName

setNmMethodName

setMethodName

setReadOnly

setReferenced

setProcessed

setRelationType

setSerialized

setClearOnRemoteSave

setReversed

setTracked

setWriteOnly

setSelectionType

setSelectionCached

setSelectionFromMainClass

setSelectionWurbletArguments