org.caleigo.core.meta
Class MetaEntityRelation

java.lang.Object
  org.caleigo.core.AbstractEntityDescriptor
      org.caleigo.core.meta.AbstractMetaEntityDescriptor
          org.caleigo.core.meta.MetaEntityRelation

All Implemented Interfaces:

IEntityDescriptor, java.io.Serializable

public class MetaEntityRelation

extends AbstractMetaEntityDescriptor

MetaEntityRelation is the descriptor for MetaEntityRelationEntity objects.

Version:

1.0.0

Author:

dennis

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class org.caleigo.core.AbstractEntityDescriptor

AbstractEntityDescriptor.DeleteEntityAction, AbstractEntityDescriptor.Dezerializer, AbstractEntityDescriptor.StoreEntityAction

Field Summary

static IFieldDescriptor	CodeName The CodeName field (index=1) has the data type STRING(100).
static IFieldDescriptor	ForwardName The ForwardName field (index=2) has the data type STRING(50).
static MetaEntityRelation	instance The singleton instance for the MetaEntityRelation entity descriptor.
static IFieldDescriptor	ReferenceEntity The ReferenceEntity field (index=4) has the data type STRING(50).
static IFieldDescriptor	ReverseName The ReververseName field (index=3) has the data type STRING(50).
static IFieldDescriptor	SourceName The SourceName field (index=0) has the data type STRING(100).
static IFieldDescriptor	TargetEntity The TargetEntity field (index=5) has the data type STRING(50).

Fields inherited from class org.caleigo.core.AbstractEntityDescriptor

CACHEABLE, CREATABLE, DELETABLE, EDITABLE, LISTABLE, SCANABLE, SELECTABLE

Fields inherited from interface org.caleigo.core.IEntityDescriptor

CUSTOM_ENTITY, DELETE_ACTION, LINK_ENTITY, MASTER_ENTITY, NO_TIME_LIMIT, SLAVE_ENTITY, STATIC_ENTITY, STORE_ACTION

Method Summary

static MetaEntityRelationEntity	create() Creates a new MetaEntityRelationEntity with default values set
static MetaEntityRelationEntity	create(IDataProvider propertySource) Creates a new MetaEntityRelationEntity, setting any field values avaivlable from the provided IDataProvider.
protected IEntityAction	createDeleteAction() Creates and returns the delete action for entity objects of the type described by the called entity descriptor.
static MetaEntityRelationEntity	load(Qualifier identityQualifier) Loads a single MetaEntityRelationEntity instance identified by by the provided identity-qualifier from the default data source.
static MetaEntityRelationEntity	load(java.lang.String aSourceName) Loads a single MetaEntityRelationEntity instance identified by by the provided identity field values from the default data source.

Methods inherited from class org.caleigo.core.AbstractEntityDescriptor

addEntityAction, contains, createCalculatedFieldDescriptors, createEntity, createEntity, createEntityRelation, createEntityRelation, createEntityRelation, createFieldDescriptor, createFieldRelation, createStoreAction, defineEntityActions, getAction, getAction, getActionCount, getActions, getCacheTime, getCodeName, getDataFieldCount, getDataSourceDescriptor, getDisplayName, getEntityClass, getEntityRelation, getEntityRelationCount, getEntityRelationIndex, getEntityRelations, getEntityType, getFieldCount, getFieldDescriptor, getFieldDescriptor, getFieldDescriptors, getFieldIndex, getFieldIndex, getHomeClass, getJNDIName, getNaturalOrder, getRemoteClass, getSourceName, isCacheable, isCreatable, isDeletable, isEditable, isListable, isScanable, isSelectable, loadEntity, loadSelection, setCacheTime, setFlags, toString, writeReplace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

instance

public static final MetaEntityRelation instance

The singleton instance for the MetaEntityRelation entity descriptor. Access it as MetaEntityRelation.instance anywhere in the code.

SourceName

public static final IFieldDescriptor SourceName

The SourceName field (index=0) has the data type STRING(100). SourceName is a required identity field.

CodeName

public static final IFieldDescriptor CodeName

The CodeName field (index=1) has the data type STRING(100). CodeName is a required field.

ForwardName

public static final IFieldDescriptor ForwardName

The ForwardName field (index=2) has the data type STRING(50). ForwardName is a required field.

ReverseName

public static final IFieldDescriptor ReverseName

The ReververseName field (index=3) has the data type STRING(50). ReververseName is a required field.

ReferenceEntity

public static final IFieldDescriptor ReferenceEntity

The ReferenceEntity field (index=4) has the data type STRING(50). ReferenceEntity is a required field.

TargetEntity

public static final IFieldDescriptor TargetEntity

The TargetEntity field (index=5) has the data type STRING(50). TargetEntity is a required field.

Method Detail

create

public static MetaEntityRelationEntity create()

Creates a new MetaEntityRelationEntity with default values set

create

public static MetaEntityRelationEntity create(IDataProvider propertySource)

Creates a new MetaEntityRelationEntity, setting any field values avaivlable from the provided IDataProvider.

load

public static MetaEntityRelationEntity load(java.lang.String aSourceName)

Loads a single MetaEntityRelationEntity instance identified by by the provided identity field values from the default data source. Returns null if no entity could be identified by field values.

load

public static MetaEntityRelationEntity load(Qualifier identityQualifier)

Loads a single MetaEntityRelationEntity instance identified by by the provided identity-qualifier from the default data source. Returns null if no entity could be identified by the provided qualifier.

createDeleteAction

protected IEntityAction createDeleteAction()

Description copied from class: AbstractEntityDescriptor

Creates and returns the delete action for entity objects of the type described by the called entity descriptor. The method can be used to return an modified delete action that for example could be used to backup the deleted data to another format.

Overrides:

createDeleteAction in class AbstractEntityDescriptor

Returns:

The IEntityAction object that should be used to delete entity objects for the called entity. By default the nested DeleteEntityAction class will be returned.