Class OptionalReference<E extends Entity>

java.lang.Object

ch.nolix.system.objectdata.model.AbstractField

ch.nolix.system.objectdata.model.AbstractBaseReference<E>

ch.nolix.system.objectdata.model.OptionalReference<E>

Type Parameters:

E - the type of the Entity a OptionalReference can reference.

All Implemented Interfaces:

NameHolder, Clearable, EmptinessRequestable, StateRequestable<DatabaseObjectState>, DatabaseComponent<IDatabase>, EntityComponent<Entity>, TableComponent<ITable<? extends Entity>>, OpennessRequestable, DatabaseObject, CreationRequestable, DatabaseConnectionRequestable, DeletionRequestable, EditingRequestable, LoadingRequestable, MandatorynessRequestable, BaseReference, Field, IOptionalReference<E>

public final class OptionalReference<E extends Entity>
extends AbstractBaseReference<E>
implements IOptionalReference<E>

Author:

Silvan Wyss

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes the elements of the current Clearable.
static <T extends Entity> OptionalReference<T>	forEntityTypes(ExtendedIterable<Class<? extends T>> entityTypes)
static <T extends Entity> OptionalReference<T>	forEntityTypes(Class<? extends T>... entityTypes)
static <T extends Entity> OptionalReference<T>	forReferenceableTableNames(ExtendedIterable<String> referenceableTableNames)
static <T extends Entity> OptionalReference<T>	forReferenceableTableNames(String... referenceableTableNames)
String	getReferencedEntityId()
String	getReferencedTableId()
String	getReferencedTableName()
ExtendedIterable<BaseBackReference>	getStoredBaseBackReferencesWhoReferencesBackThis()
E	getStoredReferencedEntity()
ITable<E>	getStoredReferencedTable()
FieldType	getType()
void	internalSetNullableValue(Object nullableValue, String nullableAdditionalValue)
boolean	isEmpty()
boolean	isMandatory()
boolean	referencesEntity(Entity entity)
boolean	referencesUninsertedEntity()
void	setEntity(Object entity)
void	setEntityById(String id)

Methods inherited from class AbstractBaseReference

getReferenceableTableNames, getStoredBackReferencedBaseReferences, referencesBackEntity, referencesBackEntityWithId, referencesBackField

Methods inherited from class AbstractField

belongsToDatabase, belongsToEntity, belongsToTable, getName, getState, getStoredParentColumn, getStoredParentDatabase, getStoredParentEntity, getStoredParentTable, internalSetParentColumn, internalSetParentEntity, isClosed, isConnectedWithRealDatabase, isDeleted, isEdited, isLoaded, isNew, knowsParentColumn, setUpdateAction

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface BaseReference

getReferenceableTableNames

Methods inherited from interface CreationRequestable

isNew

Methods inherited from interface DatabaseComponent

belongsToDatabase, getStoredParentDatabase

Methods inherited from interface DatabaseConnectionRequestable

isConnectedWithRealDatabase

Methods inherited from interface DeletionRequestable

isDeleted

Methods inherited from interface EditingRequestable

isEdited

Methods inherited from interface EmptinessRequestable

containsAny

Methods inherited from interface EntityComponent

belongsToEntity, getStoredParentEntity

Methods inherited from interface Field

getStoredBackReferencedBaseReferences, getStoredParentColumn, internalSetParentColumn, internalSetParentEntity, knowsParentColumn, referencesBackEntity, referencesBackEntityWithId, referencesBackField, setUpdateAction

Methods inherited from interface LoadingRequestable

isLoaded

Methods inherited from interface MandatorynessRequestable

isOptional

Methods inherited from interface NameHolder

getName, getNameInSingleQuotes, hasName, hasSameNameAs

Methods inherited from interface OpennessRequestable

isClosed, isOpen

Methods inherited from interface StateRequestable

getState

Methods inherited from interface TableComponent

belongsToTable, getStoredParentTable

Method Details

forEntityTypes

@SafeVarargs
public static <T extends Entity>
OptionalReference<T> forEntityTypes(Class<? extends T>... entityTypes)

forEntityTypes

public static <T extends Entity>
OptionalReference<T> forEntityTypes(ExtendedIterable<Class<? extends T>> entityTypes)

forReferenceableTableNames

public static <T extends Entity>
OptionalReference<T> forReferenceableTableNames(ExtendedIterable<String> referenceableTableNames)

forReferenceableTableNames

public static <T extends Entity>
OptionalReference<T> forReferenceableTableNames(String... referenceableTableNames)

clear

public void clear()

Removes the elements of the current Clearable.

Specified by:

clear in interface Clearable

getReferencedEntityId

public String getReferencedEntityId()

Specified by:

getReferencedEntityId in interface IOptionalReference<E extends Entity>

getReferencedTableId

public String getReferencedTableId()

Specified by:

getReferencedTableId in interface IOptionalReference<E extends Entity>

getReferencedTableName

public String getReferencedTableName()

Specified by:

getReferencedTableName in interface IOptionalReference<E extends Entity>

getStoredBaseBackReferencesWhoReferencesBackThis

public ExtendedIterable<BaseBackReference> getStoredBaseBackReferencesWhoReferencesBackThis()

Specified by:

getStoredBaseBackReferencesWhoReferencesBackThis in interface Field

getStoredReferencedEntity

public E getStoredReferencedEntity()

Specified by:

getStoredReferencedEntity in interface IOptionalReference<E extends Entity>

getStoredReferencedTable

public ITable<E> getStoredReferencedTable()

Specified by:

getStoredReferencedTable in interface IOptionalReference<E extends Entity>

getType

public FieldType getType()

Specified by:

getType in interface Field

internalSetNullableValue

public void internalSetNullableValue(Object nullableValue,
 String nullableAdditionalValue)

Specified by:

internalSetNullableValue in interface Field

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface EmptinessRequestable

Returns:

true if EmptinessRequestable does not contain an element, false otherwise

isMandatory

public boolean isMandatory()

Specified by:

isMandatory in interface MandatorynessRequestable

Returns:

true if the current MandatorynessRequestable is mandatory, false otherwise

referencesEntity

public boolean referencesEntity(Entity entity)

Specified by:

referencesEntity in interface Field

referencesUninsertedEntity

public boolean referencesUninsertedEntity()

Specified by:

referencesUninsertedEntity in interface Field

setEntity

public void setEntity(Object entity)

Specified by:

setEntity in interface IOptionalReference<E extends Entity>

setEntityById

public void setEntityById(String id)

Specified by:

setEntityById in interface IOptionalReference<E extends Entity>