de.ipcon.schema

Class EntityDefinition

java.lang.Object

de.ipcon.schema.EntityDefinition

All Implemented Interfaces:

BasicEntityI, StructuredEntityI

Direct Known Subclasses:

CBOEntity

public class EntityDefinition
extends java.lang.Object
implements StructuredEntityI

"Bare bones" information about an entity.

Field Summary

Fields inherited from interface de.ipcon.schema.StructuredEntityI

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
EntityDefinition()
EntityDefinition(java.lang.String _name, java.lang.String _base, java.lang.String _plural, java.lang.String _sqlName)
EntityDefinition(java.lang.String _name, java.lang.String _base, java.lang.String _plural, java.lang.String _sqlName, java.lang.String _description)
EntityDefinition(java.lang.String _name, java.lang.String _base, java.lang.String _plural, java.lang.String _sqlName, java.lang.String _description, boolean _persistent)
EntityDefinition(java.lang.String _name, java.lang.String _base, java.lang.String _plural, java.lang.String _sqlName, java.lang.String _description, boolean _persistent, boolean _userAbstract)
EntityDefinition(java.lang.String _name, java.lang.String _base, java.lang.String _plural, java.lang.String _sqlName, java.lang.String _description, boolean _persistent, boolean _userAbstract, boolean _codeCustom)

Method Summary

Modifier and Type	Method and Description
void	addAttribute(AttributeDefinition ad)
electric.xml.Element	asXMLElement()
EntityDefinition	checkDescription(java.lang.String desc) Checks the description of this EntityDefinition (or its base entity) equals the given String
static void	checkValidSqlName(electric.xml.Element elem, java.lang.String sqlNameToCheck) Checks wether the given String represents a valid sqlName for a CBOEntity.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,AttributeI>	getAllAttributeMap()
java.util.Map<java.lang.String,AttributeI>	getAttributeAllMap()
java.util.ArrayList<AttributeDefinition>	getAttributeDefinitions()
java.util.List<AttributeI>	getAttributeList() Returns a List with the AttributeI-s added by/defined exactly on this CBOEntity.
java.util.Map<java.lang.String,AttributeI>	getAttributeMap()
java.lang.String	getBase()
EntityI	getBaseEntity()
java.lang.Class	getClazz() Returns the Class object representing this entity.
java.util.Set<java.lang.String>	getCustomClassInModulesOrProject()
java.lang.String	getDescription() Returns the description String of this BasicEntityI instance or of the first base BasicEntityI that has a description.
electric.xml.Element	getEl()
java.lang.String	getFolderName() Returns the folder name of this BasicEntityI as used in the navigation tree in the GUI.
java.lang.String	getFQName()
AttributeI[]	getFrappingAttributes()
java.util.Collection<SchemaInterfaceI>	getImplementedSchemaInterfaces() Return all implemented interfaces as SchemaInterfaceI objects, from which further information may be obtained.
java.util.Set<java.lang.String>	getModulePackages() Returns the names of the module packages this BasicEntityI is appearing in.
java.lang.String	getName() Returns the name of this BasicEntityI instance.
AttributeI[]	getNonPersistentAttributes()
java.util.Set<java.lang.String>	getOrCreateCustomClassInModulesOrProjectSet()
java.util.Set<java.lang.String>	getOrCreateModulePackagesSet() Returns the names of the modules this BasicEntityI is appearing in.
java.lang.String	getPackage()
java.lang.String	getPackageAsPath()
java.lang.String	getPlural()
SchemaI	getSchema()
AttributeI	getSingleAttribute(java.lang.String s) Returns the AttributeI for the specified name, which must match either the plural or singular form.
java.lang.String	getSqlName()
java.lang.String	getSqlName(boolean quiet)
java.util.List<EntityI>	getSubEntityList() return a List of EntityI containing every EntityI that has this StructuredEntityI as StructuredEntityI.getBaseEntity().
int	hashCode()
boolean	hasSubEntities()
void	initCaches() Initialize a cache with all attribute of the current Entity
boolean	isCustom()
boolean	isPersistent()
boolean	isUserAbstract()
static EntityDefinition	of(java.lang.String _name, java.lang.String _base, java.lang.String _plural, java.lang.String _sqlName)
static EntityDefinition	of(java.lang.String _name, java.lang.String _base, java.lang.String _plural, java.lang.String _sqlName, java.lang.String _description)
static EntityDefinition	of(java.lang.String _name, java.lang.String _base, java.lang.String _plural, java.lang.String _sqlName, java.lang.String _description, boolean _persistent)
static EntityDefinition	of(java.lang.String _name, java.lang.String _base, java.lang.String _plural, java.lang.String _sqlName, java.lang.String _description, boolean _persistent, boolean _userAbstract)
static EntityDefinition	of(java.lang.String _name, java.lang.String _base, java.lang.String _plural, java.lang.String _sqlName, java.lang.String _description, boolean _persistent, boolean _userAbstract, boolean _codeCustom)
void	setAllAttributeMap(java.util.Map<java.lang.String,AttributeI> $39)
void	setAttributeAllMap(java.util.Map<java.lang.String,AttributeI> $38)
void	setAttributeDefinitions(java.util.ArrayList<AttributeDefinition> $31)
void	setAttributeList(java.util.List<AttributeI> $37)
void	setAttributeMap(java.util.Map<java.lang.String,AttributeI> $36)
void	setBase(java.lang.String $28)
void	setBaseEntity(EntityI $34)
void	setClazz(java.lang.Class $30)
void	setCustom(boolean b)
void	setDescription(java.lang.String $35)
void	setEl(electric.xml.Element $42)
void	setFolderName(java.lang.String $41)
void	setName(java.lang.String $27)
void	setPersistent(boolean $32)
void	setPlural(java.lang.String $29)
void	setSchema(SchemaI $26)
void	setSqlName(java.lang.String s)
void	setSqlName(java.lang.String s, boolean quiet)
void	setSubEntityList(java.util.List<EntityI> $40)
void	setUserAbstract(boolean $33)
void	writeSchemaDefinition(java.io.Writer writer)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.ipcon.schema.StructuredEntityI

filterAttributes, getAllAttributeList, getAllAttributeList, getAllAttributeList, getAllAttributeListByType, getAllAttributeListByType, getAllAttributeListByType, getAllAttributeListByType, getAllAttributeListWithoutSubentities, getAllAttributeListWithoutSubentities, getAllCoreAttributeList, getAllModuleAttributeList, getAllProjectAttributeList, getAllSubEntityList, getAllSubEntityList, getAllSubEntityList, getAttChain, getAttChain, getAttribute, getAttribute, getPersistentBaseEntity, hasPersistentSubentity, isEffectivelyPersistent, isImplicitlyPersistent, isSubEntityOf, isSubEntityOf

Methods inherited from interface de.ipcon.schema.BasicEntityI

getAttributeListByType, getAttributeListByType, getCurrentModuleOrProject, getRelations, isCustom, newInstance

Constructor Detail

EntityDefinition

public EntityDefinition(java.lang.String _name,
                        java.lang.String _base,
                        java.lang.String _plural,
                        java.lang.String _sqlName)

EntityDefinition

public EntityDefinition(java.lang.String _name,
                        java.lang.String _base,
                        java.lang.String _plural,
                        java.lang.String _sqlName,
                        java.lang.String _description)

EntityDefinition

public EntityDefinition(java.lang.String _name,
                        java.lang.String _base,
                        java.lang.String _plural,
                        java.lang.String _sqlName,
                        java.lang.String _description,
                        boolean _persistent)

EntityDefinition

public EntityDefinition(java.lang.String _name,
                        java.lang.String _base,
                        java.lang.String _plural,
                        java.lang.String _sqlName,
                        java.lang.String _description,
                        boolean _persistent,
                        boolean _userAbstract)

EntityDefinition

public EntityDefinition(java.lang.String _name,
                        java.lang.String _base,
                        java.lang.String _plural,
                        java.lang.String _sqlName,
                        java.lang.String _description,
                        boolean _persistent,
                        boolean _userAbstract,
                        boolean _codeCustom)

EntityDefinition

public EntityDefinition()

Method Detail

of

public static EntityDefinition of(java.lang.String _name,
                                  java.lang.String _base,
                                  java.lang.String _plural,
                                  java.lang.String _sqlName)

of

public static EntityDefinition of(java.lang.String _name,
                                  java.lang.String _base,
                                  java.lang.String _plural,
                                  java.lang.String _sqlName,
                                  java.lang.String _description)

of

public static EntityDefinition of(java.lang.String _name,
                                  java.lang.String _base,
                                  java.lang.String _plural,
                                  java.lang.String _sqlName,
                                  java.lang.String _description,
                                  boolean _persistent)

of

public static EntityDefinition of(java.lang.String _name,
                                  java.lang.String _base,
                                  java.lang.String _plural,
                                  java.lang.String _sqlName,
                                  java.lang.String _description,
                                  boolean _persistent,
                                  boolean _userAbstract)

of

public static EntityDefinition of(java.lang.String _name,
                                  java.lang.String _base,
                                  java.lang.String _plural,
                                  java.lang.String _sqlName,
                                  java.lang.String _description,
                                  boolean _persistent,
                                  boolean _userAbstract,
                                  boolean _codeCustom)

initCaches

public void initCaches()

Initialize a cache with all attribute of the current Entity

getOrCreateCustomClassInModulesOrProjectSet

public java.util.Set<java.lang.String> getOrCreateCustomClassInModulesOrProjectSet()

Specified by:

getOrCreateCustomClassInModulesOrProjectSet in interface BasicEntityI

getCustomClassInModulesOrProject

public java.util.Set<java.lang.String> getCustomClassInModulesOrProject()

Specified by:

getCustomClassInModulesOrProject in interface BasicEntityI

isCustom

public boolean isCustom()

Specified by:

isCustom in interface BasicEntityI

Returns:

true, if this BasicEntityI has a custom implementation and not only generated code

setCustom

public void setCustom(boolean b)

getOrCreateModulePackagesSet

public java.util.Set<java.lang.String> getOrCreateModulePackagesSet()

Description copied from interface: BasicEntityI

Returns the names of the modules this BasicEntityI is appearing in. Creates and sets a new set if none exists yet.

Specified by:

getOrCreateModulePackagesSet in interface BasicEntityI

Returns:

The names of the modules this BasicEntityI is appearing in.

getModulePackages

public java.util.Set<java.lang.String> getModulePackages()

Description copied from interface: BasicEntityI

Returns the names of the module packages this BasicEntityI is appearing in.

Specified by:

getModulePackages in interface BasicEntityI

Returns:

The names of the module packages this BasicEntityI is appearing in.

addAttribute

public void addAttribute(AttributeDefinition ad)

getPackage

public java.lang.String getPackage()

getPackageAsPath

public java.lang.String getPackageAsPath()

getFQName

public java.lang.String getFQName()

getClazz

public java.lang.Class getClazz()

Description copied from interface: BasicEntityI

Returns the Class object representing this entity.

Specified by:

getClazz in interface BasicEntityI

Returns:

The Class object for this entity.

checkDescription

public EntityDefinition checkDescription(java.lang.String desc)

Checks the description of this EntityDefinition (or its base entity) equals the given String

Parameters:

desc - the String to check for equality against the description of this EntityDefinition (or its base entity)

getDescription

public java.lang.String getDescription()

Description copied from interface: BasicEntityI

Returns the description String of this BasicEntityI instance or of the first base BasicEntityI that has a description. Falls back to the name of this BasicEntityI with appended Id in brackets. Used for formatting BOs having this BasicEntityI as type.

Specified by:

getDescription in interface BasicEntityI

Returns:

the description String of this BasicEntityI instance or of the first base BasicEntityI that has a description.

setSqlName

public void setSqlName(java.lang.String s)

setSqlName

public void setSqlName(java.lang.String s,
                       boolean quiet)

getSqlName

public java.lang.String getSqlName()

getSqlName

public java.lang.String getSqlName(boolean quiet)

checkValidSqlName

public static void checkValidSqlName(electric.xml.Element elem,
                                     java.lang.String sqlNameToCheck)
                              throws SchemaDefinitionException

Checks wether the given String represents a valid sqlName for a CBOEntity. Additionally to the checks in CBOSchema.checkSyntacticallyValidSqlName(Element, String, String) it checks for a name clash with internally used names.

Throws:

EntityDefinitionException - if the sqlName is not valid

SchemaDefinitionException

getImplementedSchemaInterfaces

public java.util.Collection<SchemaInterfaceI> getImplementedSchemaInterfaces()

Return all implemented interfaces as SchemaInterfaceI objects, from which further information may be obtained.

Specified by:

getImplementedSchemaInterfaces in interface BasicEntityI

Returns:

all implemented interfaces as SchemaInterfaceI objects.

hasSubEntities

public boolean hasSubEntities()

Specified by:

hasSubEntities in interface StructuredEntityI

Returns:

true if this EntityI has sub entities

getSingleAttribute

public AttributeI getSingleAttribute(java.lang.String s)

Description copied from interface: BasicEntityI

Returns the AttributeI for the specified name, which must match either the plural or singular form.

Specified by:

getSingleAttribute in interface BasicEntityI

Parameters:

s - The name to get the AttributeI for.

Returns:

The AttributeI for the specified name.

getNonPersistentAttributes

public final AttributeI[] getNonPersistentAttributes()

getFrappingAttributes

public final AttributeI[] getFrappingAttributes()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

writeSchemaDefinition

public void writeSchemaDefinition(java.io.Writer writer)
                           throws java.io.IOException

Throws:

java.io.IOException

asXMLElement

public electric.xml.Element asXMLElement()

getSchema

public SchemaI getSchema()

Specified by:

getSchema in interface BasicEntityI

setSchema

public void setSchema(SchemaI $26)

getName

public java.lang.String getName()

Description copied from interface: BasicEntityI

Returns the name of this BasicEntityI instance. Can also be used for querying objects of that kind in OQL queries.

Specified by:

getName in interface BasicEntityI

Returns:

the name of this BasicEntityI instance.

setName

public void setName(java.lang.String $27)

getBase

public java.lang.String getBase()

setBase

public void setBase(java.lang.String $28)

getPlural

public java.lang.String getPlural()

Specified by:

getPlural in interface BasicEntityI

Returns:

the plural name of this BasicEntityI instance.

setPlural

public void setPlural(java.lang.String $29)

setClazz

public void setClazz(java.lang.Class $30)

getAttributeDefinitions

public java.util.ArrayList<AttributeDefinition> getAttributeDefinitions()

setAttributeDefinitions

public void setAttributeDefinitions(java.util.ArrayList<AttributeDefinition> $31)

isPersistent

public boolean isPersistent()

Specified by:

isPersistent in interface BasicEntityI

Returns:

true if this BasicEntityI is defined as persistent in the schema.

setPersistent

public void setPersistent(boolean $32)

isUserAbstract

public boolean isUserAbstract()

Specified by:

isUserAbstract in interface BasicEntityI

Returns:

true if this BasicEntityI is defined as abstract in the schema.

setUserAbstract

public void setUserAbstract(boolean $33)

getBaseEntity

public EntityI getBaseEntity()

Specified by:

getBaseEntity in interface StructuredEntityI

Returns:

the base (i.e. super-) EntityI of this EntityI

setBaseEntity

public void setBaseEntity(EntityI $34)

setDescription

public void setDescription(java.lang.String $35)

getAttributeMap

public java.util.Map<java.lang.String,AttributeI> getAttributeMap()

setAttributeMap

public void setAttributeMap(java.util.Map<java.lang.String,AttributeI> $36)

getAttributeList

public java.util.List<AttributeI> getAttributeList()

Description copied from interface: BasicEntityI

Returns a List with the AttributeI-s added by/defined exactly on this CBOEntity. Excludes inherited Attributes.

Specified by:

getAttributeList in interface BasicEntityI

Returns:

A List of attributes specific to this CBOEntity.

setAttributeList

public void setAttributeList(java.util.List<AttributeI> $37)

getAttributeAllMap

public java.util.Map<java.lang.String,AttributeI> getAttributeAllMap()

setAttributeAllMap

public void setAttributeAllMap(java.util.Map<java.lang.String,AttributeI> $38)

getAllAttributeMap

public java.util.Map<java.lang.String,AttributeI> getAllAttributeMap()

setAllAttributeMap

public void setAllAttributeMap(java.util.Map<java.lang.String,AttributeI> $39)

getSubEntityList

public java.util.List<EntityI> getSubEntityList()

Description copied from interface: StructuredEntityI

return a List of EntityI containing every EntityI that has this StructuredEntityI as StructuredEntityI.getBaseEntity(). Does not include this StructuredEntityI or transitive sub-EntityI-s.

Specified by:

getSubEntityList in interface StructuredEntityI

setSubEntityList

public void setSubEntityList(java.util.List<EntityI> $40)

getFolderName

public java.lang.String getFolderName()

Description copied from interface: BasicEntityI

Returns the folder name of this BasicEntityI as used in the navigation tree in the GUI.

Specified by:

getFolderName in interface BasicEntityI

Returns:

The folder name.

setFolderName

public void setFolderName(java.lang.String $41)

getEl

public electric.xml.Element getEl()

setEl

public void setEl(electric.xml.Element $42)