de.schwarzrot.data.meta
Class DatabaseModel

java.lang.Object
  com.jgoodies.binding.beans.Model
      de.schwarzrot.data.support.AbstractEntity
          de.schwarzrot.data.meta.support.AbstractMetaEntity<String>
              de.schwarzrot.data.meta.DatabaseModel

All Implemented Interfaces:

com.jgoodies.binding.beans.Observable, Entity, MetaEntity<String>, NamedEntity<String>, Serializable, Comparable<Entity>

public class DatabaseModel
extends AbstractMetaEntity<String>

See Also:

Serialized Form

Field Summary

Fields inherited from class de.schwarzrot.data.meta.support.AbstractMetaEntity

MODEL_SCHEMA

Constructor Summary

DatabaseModel()

Method Summary

AttributeDomain	findAttributeDomain(ColumnType ct, int size)
AttributeDomain	findAttributeDomain(ColumnType ct, int size, int decimals, boolean autoIncrement)
AttributeDomain	findAttributeDomain(String name)
void	fixImported(Converter cnv)
List<AttributeDomain>	getAttributeDomains()
String	getDefaultPassword()
String	getDefaultUser()
Map<ColumnType,Map<String,AttributeDomain>>	getDomainAccess()
Map<String,String>	getMappings() returns a map with mappings of logical property names to physical property names (column names in database terms).
String	getPersistenceName() returns the name of the entity for persistance.
long	getRevision()
Map<String,SchemaDefinition>	getSchemata()
Map<String,Integer>	getSkipList() returns a map with property names, that EntityManagers should ignore.
List<String>	getUniqColumnNames() returns a list of property names, which serve to detect a uniq instance without the usage of the primary key.
void	initNew()
void	putAttributeDomain(AttributeDomain ad)
void	removeAttributeDomain(AttributeDomain ad)
void	setAttributeDomains(List<AttributeDomain> attrDomains)
void	setDefaultPassword(String defPw)
void	setDefaultUser(String defUser)
void	setRevision(long revision)
void	setSchemata(Map<String,SchemaDefinition> schemata)
protected void	setupDomainAccess(AttributeDomain ad)
void	validate(boolean read) will be called just before saving and after loading, so it is intended to give the opportunity to calculate virtual fields.

Methods inherited from class de.schwarzrot.data.meta.support.AbstractMetaEntity

compareTo, getComment, getLogicalName, getName, getPhysID, getSchemaName, setComment, setName, setPhysID

Methods inherited from class de.schwarzrot.data.support.AbstractEntity

adoptChildren, adoptChildren, adoptGroupedChildren, equals, getCModified, getCode, getDefaultOrder, getDtCreated, getDtModified, getId, getLogger, getSystemClass, getUCreated, getUModified, getUserAttributes, getVariantColumnName, getVariantTypeMap, hashCode, isDirty, isUserType, isVirtual, setCModified, setDirty, setDtCreated, setDtModified, setId, setSchemaName, setUCreated, setUModified, toString

Methods inherited from class com.jgoodies.binding.beans.Model

addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, equals, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, fireMultiplePropertiesChanged, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getPropertyChangeListeners, getPropertyChangeListeners, getVetoableChangeListeners, getVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.schwarzrot.data.Entity

getCModified, getDefaultOrder, getDtCreated, getDtModified, getId, getSystemClass, getUCreated, getUModified, getUserAttributes, getVariantColumnName, getVariantTypeMap, isDirty, isUserType, isVirtual, setCModified, setDirty, setDtCreated, setDtModified, setId, setUCreated, setUModified

Methods inherited from interface com.jgoodies.binding.beans.Observable

addPropertyChangeListener, removePropertyChangeListener

Constructor Detail

DatabaseModel

public DatabaseModel()

Method Detail

findAttributeDomain

public AttributeDomain findAttributeDomain(ColumnType ct,
                                           int size)

findAttributeDomain

public AttributeDomain findAttributeDomain(ColumnType ct,
                                           int size,
                                           int decimals,
                                           boolean autoIncrement)

findAttributeDomain

public AttributeDomain findAttributeDomain(String name)

fixImported

public void fixImported(Converter cnv)

getAttributeDomains

public final List<AttributeDomain> getAttributeDomains()

getDefaultPassword

public final String getDefaultPassword()

getDefaultUser

public final String getDefaultUser()

getDomainAccess

public final Map<ColumnType,Map<String,AttributeDomain>> getDomainAccess()

getMappings

public Map<String,String> getMappings()

Description copied from interface: Entity

returns a map with mappings of logical property names to physical property names (column names in database terms).

Every implementation should respect the parents mappings. The following sample shows different mapping types:

 public Map<String, String> getMappings() {
     Map<String, String> mappings = super.getMappings();
     mappings.put("title", "name");
     mappings.put("streams", Stream.class.getName());
     mappings.put("pageDefinitions", "pageType|" + ThemeElement.class.getName());
     return mappings;
 }
 

The mappings explained:

"title" -> "name"

the logical "title"-attribute is stored to persistence with a physical name "name"

"streams" -> Stream.class.getName()

the "streams" property holds related children. Unknown children are hold in a List, known (named) children are hold in a Map. The mapped value is used as classname to create child instances.

"pageDefinitions" -> "pageType|" + ThemeElement.class.getName()

pageDefinitions is a property of type Map, that holds grouped children. Known children are hold by a Map, unknown children by a List, so "pageDefinitions" may contain elements of type Map, or List. pageType, a property of ThemeElement, is used to group the children. The word before the '|' is the property name used as key value for grouping and the type after '|' is used to create instances.

Specified by:

getMappings in interface Entity

Overrides:

getMappings in class AbstractMetaEntity<String>

Returns:

a Map with property names as keys and column names as values.

getPersistenceName

public String getPersistenceName()

Description copied from interface: Entity

returns the name of the entity for persistance. Normally it would be the same result as getClass().getSimpleName(), but some storage may have size limitations, or don't support case sensitive names, so this call is to deal with that kind of limitations.

Specified by:

getPersistenceName in interface Entity

Overrides:

getPersistenceName in class AbstractEntity

Returns:

the entity-name used for persistence

getRevision

public final long getRevision()

getSchemata

public final Map<String,SchemaDefinition> getSchemata()

getSkipList

public Map<String,Integer> getSkipList()

Description copied from interface: Entity

returns a map with property names, that EntityManagers should ignore. These properties may be virtual properties, that not should be saved to persistence and/or methods that start with 'get' and that are not getters.

Implemention uses HashMaps for performance reasons, but the values are never used. So the map consists of propertynames as keys and an Integer as Value.

Every implementation should use the Map from parent class:

 public Map<String, Integer> getSkipList() {
     Map<String, Integer> skipList = super.getSkipList();
     skipList.put("a_virtual_field", 1);
     return skipList;
 }
 

Specified by:

getSkipList in interface Entity

Overrides:

getSkipList in class AbstractEntity

Returns:

a Map

getUniqColumnNames

public final List<String> getUniqColumnNames()

Description copied from interface: Entity

returns a list of property names, which serve to detect a uniq instance without the usage of the primary key. In database context this list is used to decide, whether a save operation needs an update or an insert.

Specified by:

getUniqColumnNames in interface Entity

Overrides:

getUniqColumnNames in class AbstractMetaEntity<String>

Returns:

a list of property names

initNew

public void initNew()

putAttributeDomain

public void putAttributeDomain(AttributeDomain ad)

removeAttributeDomain

public void removeAttributeDomain(AttributeDomain ad)

setAttributeDomains

public final void setAttributeDomains(List<AttributeDomain> attrDomains)

setDefaultPassword

public final void setDefaultPassword(String defPw)

setDefaultUser

public final void setDefaultUser(String defUser)

setRevision

public final void setRevision(long revision)

setSchemata

public final void setSchemata(Map<String,SchemaDefinition> schemata)

validate

public void validate(boolean read)

Description copied from interface: Entity

will be called just before saving and after loading, so it is intended to give the opportunity to calculate virtual fields.

Specified by:

validate in interface Entity

Overrides:

validate in class AbstractEntity

Parameters:

read - signals whether calculation should be done for reading or for writing

setupDomainAccess

protected void setupDomainAccess(AttributeDomain ad)