VAccessor (vertigo-datamodel 3.4.0 API)

java.lang.Object
- io.vertigo.datamodel.structure.model.VAccessor<E>

Type Parameters:

E - the type of entity

All Implemented Interfaces:

Serializable
```
public class VAccessor<E extends Entity>
extends Object
implements Serializable
```
This class is a way to access an entity defined by a relationship. It's a kind of box (aka optional) that offers a small list of methods.

Author:

pchretien

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

VAccessor(DtDefinition targetDtDefinition, String role)
Constructor.

VAccessor(Class<E> clazz, String role)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`E`	`get()`
`Serializable`	`getId()`
`String`	`getRole()`
`UID<E>`	`getUID()`
`boolean`	`isLoaded()`
`void`	`set(E entity)`	Sets the entity
`void`	`setId(Serializable id)`	Sets the entity id
`void`	`setUID(UID<E> uid)`	Sets the entity uri

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

- Constructor Detail
  - VAccessor
```
public VAccessor(Class<E> clazz,
                 String role)
```
    Constructor.
    
    Parameters:
    
    clazz - the entity class
    
    role - the role of the association (case of multiple associations with the same entity)
  - VAccessor
```
public VAccessor(DtDefinition targetDtDefinition,
                 String role)
```
    Constructor.
    
    Parameters:
    
    targetDtDefinition - the entity definition
    
    role - the role of the association (case of multiple associations with the same entity)
- Method Detail
  - get
```
public final E get()
```
    Returns:
    
    the entity
  - getUID
```
public final UID<E> getUID()
```
    Returns:
    
    the entity uid
  - getId
```
public final Serializable getId()
```
    Returns:
    
    the entity id
  - set
```
public final void set(E entity)
```
    Sets the entity
    
    Parameters:
    
    entity - the entity
  - setId
```
public final void setId(Serializable id)
```
    Sets the entity id
    
    Parameters:
    
    id - the entity id
  - setUID
```
public final void setUID(UID<E> uid)
```
    Sets the entity uri
    
    Parameters:
    
    uid - the entity uri
  - getRole
```
public final String getRole()
```
    Returns:
    
    Role of this relation
  - isLoaded
```
public final boolean isLoaded()
```
    Returns:
    
    if entity is already loaded