public interface EntityType
extends java.lang.Comparable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ABSTRACT
Constant for XML 'abstract' defintion attribute
|
static java.lang.String |
CARDINALITY
Constant for XML 'cardinality' defintion attribute
|
static java.lang.String |
COMPONENT_TYPE
Constant for XML 'componentType' defintion element
|
static java.lang.String |
CONSTANT
Constant for XML 'constant' defintion element
|
static java.lang.String |
DEFAULT
Constant for XML 'default' defintion attribute
|
static java.lang.String |
DEFAULT_REF
Constant for XML 'defaultRef' definition element
|
static java.lang.String |
DEFAULT_VALUE
Constant for XML 'defaultValue' definition element
|
static java.lang.String |
ENTITY_TYPE
Constant for XML 'entityType' defintion element
|
static java.lang.String |
EXTENDS
Constant for XML 'extends' defintion attribute
|
static java.lang.String |
FIELD
Constant for XML 'field' defintion element
|
static java.lang.String |
IS_KEY
Constant for XML 'keyness' defintion attribute
|
static java.lang.String |
NAME
Constant for XML 'name' defintion attribute
|
static java.lang.String |
ONE_OR_MANY |
static java.lang.String |
TYPE
Constant for XML 'type' defintion element
|
static java.lang.String |
VSTAMP |
static java.lang.String |
ZERO_OR_MANY |
static java.lang.String |
ZERO_OR_ONE |
Modifier and Type | Method and Description |
---|---|
boolean |
allowsChildEntities() |
boolean |
allowsComponent(EntityType type) |
boolean |
allowsReferences() |
boolean |
allowsSoftReferences() |
Field |
createField(java.lang.String fieldName,
ESPK refPK) |
Field |
createField(java.lang.String fieldName,
java.lang.String value) |
Field |
createField(java.lang.String fieldName,
Value[] values) |
boolean |
extendsType(java.lang.String parentType) |
java.util.Collection<java.lang.String> |
getAllConstantFieldNames() |
java.util.Collection<Field> |
getAllConstantFields() |
java.util.Set<java.lang.String> |
getAllDeclaredConstantFieldNames() |
java.util.Set<java.lang.String> |
getAllDeclaredFieldNames() |
java.util.Collection<java.lang.String> |
getAllDeclaredKeyFields() |
java.util.Collection<java.lang.String> |
getAllDefaultedFieldNames() |
java.util.Collection<java.lang.String> |
getAllFieldNames() |
javax.xml.parsers.DocumentBuilder |
getBuilder() |
Field |
getConstantField(java.lang.String fieldName) |
java.util.Map<java.lang.String,java.lang.Object> |
getDeclaredComponentTypes() |
FieldType |
getFieldType(java.lang.String name)
Get the field type for the specified field name.
|
java.lang.String[] |
getKeyFieldNames() |
java.lang.String |
getName() |
org.w3c.dom.Element |
getRootElement() |
EntityType |
getSuperType()
Get the super type of this type.
|
boolean |
hasSuperType(java.lang.String candidate)
Check to see if the specified type is an ancestor of this type
|
boolean |
isAbstract() |
boolean |
isCompatible(EntityType other) |
boolean |
isConstantField(java.lang.String fieldName) |
boolean |
isKeyField(Field f) |
boolean |
isSubType(EntityType candidate)
Check that the specified type is a subtype of this type.
|
java.lang.String |
serialize()
Deprecated.
Serialising XML to strings is evil. replaced by (write)
|
void |
write(java.io.OutputStream os) |
static final java.lang.String VSTAMP
static final java.lang.String TYPE
static final java.lang.String ENTITY_TYPE
static final java.lang.String FIELD
static final java.lang.String CONSTANT
static final java.lang.String COMPONENT_TYPE
static final java.lang.String NAME
static final java.lang.String EXTENDS
static final java.lang.String ABSTRACT
static final java.lang.String CARDINALITY
static final java.lang.String IS_KEY
static final java.lang.String DEFAULT
static final java.lang.String DEFAULT_REF
static final java.lang.String DEFAULT_VALUE
static final java.lang.String ZERO_OR_ONE
static final java.lang.String ZERO_OR_MANY
static final java.lang.String ONE_OR_MANY
EntityType getSuperType()
boolean hasSuperType(java.lang.String candidate)
candidate
- boolean isAbstract()
boolean isCompatible(EntityType other)
java.lang.String getName()
java.util.Collection<java.lang.String> getAllFieldNames()
FieldType getFieldType(java.lang.String name)
name
- The name of the fieldjava.util.Collection<java.lang.String> getAllDefaultedFieldNames()
java.lang.String[] getKeyFieldNames()
boolean isSubType(EntityType candidate)
candidate
- The candidate typeboolean extendsType(java.lang.String parentType)
boolean isConstantField(java.lang.String fieldName)
java.util.Collection<Field> getAllConstantFields()
java.util.Set<java.lang.String> getAllDeclaredFieldNames()
java.util.Collection<java.lang.String> getAllDeclaredKeyFields()
java.util.Set<java.lang.String> getAllDeclaredConstantFieldNames()
java.util.Collection<java.lang.String> getAllConstantFieldNames()
Field getConstantField(java.lang.String fieldName)
boolean allowsChildEntities()
boolean allowsComponent(EntityType type)
boolean allowsReferences()
Field createField(java.lang.String fieldName, ESPK refPK) throws EntityStoreException
EntityStoreException
Field createField(java.lang.String fieldName, java.lang.String value) throws EntityStoreException
EntityStoreException
Field createField(java.lang.String fieldName, Value[] values) throws EntityStoreException
EntityStoreException
boolean isKeyField(Field f)
java.util.Map<java.lang.String,java.lang.Object> getDeclaredComponentTypes()
java.lang.String serialize() throws EntityStoreException
EntityStoreException
org.w3c.dom.Element getRootElement()
void write(java.io.OutputStream os) throws java.io.IOException
java.io.IOException
boolean allowsSoftReferences()
javax.xml.parsers.DocumentBuilder getBuilder() throws EntityStoreException
EntityStoreException
This documentation and all its contents and graphics, copyright © 1999 - 2011 Vordel