AbstractReference (stumps 1.0-SNAPSHOT API)

java.lang.Object
- com.neurosys.domain.ModelObject
- - com.neurosys.domain.DomainObject
  - - com.neurosys.refs.domain.AbstractReference

All Implemented Interfaces:

Displayable, IHierarchialReference<String>, Serializable

Direct Known Subclasses:

Reference
```
@MappedSuperclass
public abstract class AbstractReference
extends DomainObject
implements IHierarchialReference<String>, Displayable
```
Use a reference for the following reasons:
- Light graph relations that support multiple getRelated() relations
- Entities that do not want to carry contextual relation with them. Instead the entity only relates to its Reference.
- Entities that can be removed, however have referential integrity. this allows all other systems to be aware of the Reference rather than the entity so even if the entity is removed it does not break anything.
In the design of entities an important consideration is if Entities should be aware of their Reference or the Reference of all its entities. The former is preferred for many reasons. Including that a Reference is a global identifier cross DBs while an entity maybe local. A local entity can always refer to a global one but a global one cannot rely on a local one universally. Plus, the more entities that use references will stress the design of the Reference to carry all those links with it. Lastly removal of an entity still keeps the Reference as is.
Author:

Arjun Dhar

See Also:

Serialized Form

Field Summary
- Fields inherited from interface com.neurosys.domain.IHierarchialReference
  ROOT

Constructor Summary

Constructors
Constructor and Description
`AbstractReference()`
`AbstractReference(AbstractReference t)`
`AbstractReference(String nameOrJson)`
`AbstractReference(String name, String meta)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getDisplayName()`
`String`	`getHierarchy()` A String like: "rootId-nodeId-subnodeId-thisId"; gives the entire picture of the hierarchy to this point.
`String`	`getId()`
`String`	`getMeta()`
`String`	`getName()` The unique name to identify the reference
`abstract AbstractReference`	`getParent()` if this Reference has any parent (main) association. Example: A.R Rahman is a "Music Director".
`abstract List<AbstractReference>`	`getRelated()` Any references this object has in `ReferenceAlias`. However will not be persisted; for that use `ReferenceAlias` explicitly. NOTE: This is a `Transient` field currently, and one must explicitly populate it.
`int`	`hashCode()`
`void`	`setHierarchy(String hierarchy)` A String like: "rootId-nodeId-subnodeId-thisId"; gives the entire picture of the hierarchy to this point.
`void`	`setId(String name)`
`void`	`setMeta(String meta)`
`void`	`setName(String name)` The unique name to identify the reference
`abstract void`	`setParent(AbstractReference parent)` if this Reference has any parent (main) association. Example: A.R Rahman is a "Music Director".
`abstract void`	`setRelated(List<AbstractReference> related)` Any references this object has in `ReferenceAlias`. However will not be persisted; for that use `ReferenceAlias` explicitly
`String`	`toString()`

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

Methods inherited from interface com.neurosys.domain.IHierarchialReference
getParentId, setParentId

- Constructor Detail
  - AbstractReference
```
public AbstractReference()
```
  - AbstractReference
```
public AbstractReference(String nameOrJson)
```
    Parameters:
    
    nameOrJson - as String. JSON or name.
  - AbstractReference
```
public AbstractReference(String name,
                         String meta)
```
  - AbstractReference
```
public AbstractReference(AbstractReference t)
```
- Method Detail
  - getName
```
public String getName()
```
    The unique name to identify the reference
    
    Specified by:
    
    getName in interface IHierarchialReference<String>
  - setName
```
public void setName(String name)
```
    The unique name to identify the reference
    
    Specified by:
    
    setName in interface IHierarchialReference<String>
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface IHierarchialReference<String>
  - setId
```
public void setId(String name)
```
    Specified by:
    
    setId in interface IHierarchialReference<String>
  - getMeta
```
public String getMeta()
```
  - setMeta
```
public void setMeta(String meta)
```
  - getParent
```
public abstract AbstractReference getParent()
```
    if this Reference has any parent (main) association.
    Example: A.R Rahman is a "Music Director". So if this Reference represents "Music Director" then its parent is the Reference object for A.R Rahman. The authority record is one that has no parent (#parent is null).
  - setParent
```
public abstract void setParent(AbstractReference parent)
```
    if this Reference has any parent (main) association.
    Example: A.R Rahman is a "Music Director". So if this Reference represents "Music Director" then its parent is the Reference object for A.R Rahman. The authority record is one that has no parent (#parent is null).
  - getRelated
```
public abstract List<AbstractReference> getRelated()
```
    Any references this object has in ReferenceAlias.
    However will not be persisted; for that use ReferenceAlias explicitly.
    NOTE: This is a Transient field currently, and one must explicitly populate it. TODO: Lazy load from ReferenceAlias
  - setRelated
```
public abstract void setRelated(List<AbstractReference> related)
```
    Any references this object has in ReferenceAlias.
    However will not be persisted; for that use ReferenceAlias explicitly
  - getDisplayName
```
public String getDisplayName()
```
    Specified by:
    
    getDisplayName in interface Displayable
  - getHierarchy
```
public String getHierarchy()
```
    Description copied from interface: IHierarchialReference
    
    A String like: "rootId-nodeId-subnodeId-thisId"; gives the entire picture of the hierarchy to this point.
    
    Specified by:
    
    getHierarchy in interface IHierarchialReference<String>
  - setHierarchy
```
public void setHierarchy(String hierarchy)
```
    Description copied from interface: IHierarchialReference
    
    A String like: "rootId-nodeId-subnodeId-thisId"; gives the entire picture of the hierarchy to this point.
    
    Specified by:
    
    setHierarchy in interface IHierarchialReference<String>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractReference

Field Summary

Fields inherited from interface com.neurosys.domain.IHierarchialReference

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.neurosys.domain.IHierarchialReference

Constructor Detail

AbstractReference

AbstractReference

AbstractReference

AbstractReference

Method Detail

getName

setName

getId

setId

getMeta

setMeta

getParent

setParent

getRelated

setRelated

getDisplayName

getHierarchy

setHierarchy

hashCode

equals

toString