org.caleigo.core.meta
Class MetaFieldDescriptor

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

All Implemented Interfaces:

IEntityDescriptor, java.io.Serializable

public class MetaFieldDescriptor

extends AbstractMetaEntityDescriptor

MetaFieldDescriptor is the descriptor for MetaFieldDescriptorEntity 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	AutoGenerated The AutoGenerated field (index=8) has the data type BOOLEAN.
static IFieldDescriptor	CodeName The CodeName field (index=2) has the data type STRING(50).
static IFieldDescriptor	DataType The DataType field (index=4) has the data type INTEGER.
static IFieldDescriptor	DefaultValue The DefaultValue field (index=6) has the data type STRING(200).
static IFieldDescriptor	DisplayName The DisplayName field (index=3) has the data type STRING(50).
static IFieldDescriptor	Entity The Entity field (index=0) has the data type STRING(50).
static IFieldDescriptor	Hidden The Hidden field (index=12) has the data type BOOLEAN.
static IFieldDescriptor	HintField The HintField field (index=14) has the data type BOOLEAN.
static IFieldDescriptor	IdentityField The IdentityField field (index=7) has the data type BOOLEAN.
static IFieldDescriptor	Indexed The Indexed field (index=9) has the data type BOOLEAN.
static MetaFieldDescriptor	instance The singleton instance for the MetaFieldDescriptor entity descriptor.
static IFieldDescriptor	Length The Length field (index=5) has the data type INTEGER.
static IFieldDescriptor	NameField The NameField field (index=13) has the data type BOOLEAN.
static IFieldDescriptor	NaturalOrder The NaturalOrder field (index=16) has the data type BOOLEAN.
static IFieldDescriptor	OverviewField The OverviewField field (index=15) has the data type BOOLEAN.
static IFieldDescriptor	ReadOnly The ReadOnly field (index=11) has the data type BOOLEAN.
static IFieldDescriptor	Required The Required field (index=10) has the data type BOOLEAN.
static IFieldDescriptor	SourceName The SourceName field (index=1) 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 MetaFieldDescriptorEntity	create() Creates a new MetaFieldDescriptorEntity with default values set
static MetaFieldDescriptorEntity	create(IDataProvider propertySource) Creates a new MetaFieldDescriptorEntity, setting any field values avaivlable from the provided IDataProvider.
static MetaFieldDescriptorEntity	load(Qualifier identityQualifier) Loads a single MetaFieldDescriptorEntity instance identified by by the provided identity-qualifier from the default data source.
static MetaFieldDescriptorEntity	load(java.lang.String aEntity, java.lang.String aSourceName) Loads a single MetaFieldDescriptorEntity 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, createDeleteAction, 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 MetaFieldDescriptor instance

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

Entity

public static final IFieldDescriptor Entity

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

SourceName

public static final IFieldDescriptor SourceName

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

CodeName

public static final IFieldDescriptor CodeName

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

DisplayName

public static final IFieldDescriptor DisplayName

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

DataType

public static final IFieldDescriptor DataType

The DataType field (index=4) has the data type INTEGER. DataType is a required field.

Length

public static final IFieldDescriptor Length

The Length field (index=5) has the data type INTEGER. Length is a required field.

DefaultValue

public static final IFieldDescriptor DefaultValue

The DefaultValue field (index=6) has the data type STRING(200). DefaultValue is a non-required field.

IdentityField

public static final IFieldDescriptor IdentityField

The IdentityField field (index=7) has the data type BOOLEAN. IdentityField is a required field.

AutoGenerated

public static final IFieldDescriptor AutoGenerated

The AutoGenerated field (index=8) has the data type BOOLEAN. AutoGenerated is a required field.

Indexed

public static final IFieldDescriptor Indexed

The Indexed field (index=9) has the data type BOOLEAN. Indexed is a required field.

Required

public static final IFieldDescriptor Required

The Required field (index=10) has the data type BOOLEAN. Required is a required field.

ReadOnly

public static final IFieldDescriptor ReadOnly

The ReadOnly field (index=11) has the data type BOOLEAN. ReadOnly is a required field.

Hidden

public static final IFieldDescriptor Hidden

The Hidden field (index=12) has the data type BOOLEAN. Hidden is a required field.

NameField

public static final IFieldDescriptor NameField

The NameField field (index=13) has the data type BOOLEAN. NameField is a required field.

HintField

public static final IFieldDescriptor HintField

The HintField field (index=14) has the data type BOOLEAN. HintField is a required field.

OverviewField

public static final IFieldDescriptor OverviewField

The OverviewField field (index=15) has the data type BOOLEAN. OverviewField is a required field.

NaturalOrder

public static final IFieldDescriptor NaturalOrder

The NaturalOrder field (index=16) has the data type BOOLEAN. NaturalOrder is a required field.

Method Detail

create

public static MetaFieldDescriptorEntity create()

Creates a new MetaFieldDescriptorEntity with default values set

create

public static MetaFieldDescriptorEntity create(IDataProvider propertySource)

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

load

public static MetaFieldDescriptorEntity load(java.lang.String aEntity,
                                             java.lang.String aSourceName)

Loads a single MetaFieldDescriptorEntity 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 MetaFieldDescriptorEntity load(Qualifier identityQualifier)

Loads a single MetaFieldDescriptorEntity 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.