com.adobe.aem.dermis.model

Class DataModel

java.lang.Object

com.adobe.aem.dermis.model.AbstractAsset

com.adobe.aem.dermis.model.DataModel

All Implemented Interfaces:

IAsset, IDataModel, Serializable

public class DataModel
extends AbstractAsset
implements IDataModel

Represents a DataModel and it's metadata description. DataModels reside within a schema and contains properties and relationships to other datamodels.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataModel()
DataModel(String name, String schemaName)
DataModel(String name, String schemaName, List<IProperty> properties)
DataModel(String name, String schemaName, List<IProperty> properties, List<Relationship> relationships)

Method Summary

Modifier and Type	Method and Description
void	addAssociation(PropertyType associationType, String name, IDataModel dataModel) Add the associated datamodel
void	addProperties(List<IProperty> addProperties)
void	addProperty(IProperty property) Add property to data model
String	getId() Gets the identifier of this Asset
IProperty[]	getPrimaryKeys() Gets the properties of this datamodel that are known to be primary keys.
List<IProperty>	getProperties() Gets the properties of this datamodel.
IProperty	getPropertyByName(String propertyName) Convenience method for retrieving a property by it's name.
String[]	getPropertyNames() Gets the names of this datamodel's properties.
List<Relationship>	getRelationships()
List<Relationship>	getRelationships(IDataModel otherDataModel) Gets relationships between this dataModel and another dataModel.
String[]	getRequired()
String	getSchemaName() Gets the name of schema in which this datamodel resides in.
boolean	isBinaryEntity()
boolean	isDefaultBinaryEntity()
boolean	isGenericOperationAllowed() Flag represents whether this entity can be bind with generic operations
boolean	isRootEntity() RootEntity is true if it is either an argument or return type of an operation
void	setBinaryEntity(boolean binaryEntity)
void	setDefaultBinaryEntity(boolean defaultBinaryEntity)
void	setGenericOperationAllowed(boolean genericOperationAllowed) Set true if generic operations are allowed in this dataModel.
void	setId(String id)
void	setProperties(List<? extends IProperty> properties) Sets the properties of this datamodel.
void	setRelationships(List<Relationship> relationships)
void	setRequired(String[] required)
void	setRootEntity(boolean value)
void	setSchemaName(String schemaName)

Methods inherited from class com.adobe.aem.dermis.model.AbstractAsset

getDescription, getName, getTitle, setDescription, setName, setTitle

Methods inherited from interface com.adobe.aem.dermis.model.IAsset

getDescription, getName, getTitle

Constructor Detail

DataModel

public DataModel()

DataModel

public DataModel(String name,
                 String schemaName)

DataModel

public DataModel(String name,
                 String schemaName,
                 List<IProperty> properties)

DataModel

public DataModel(String name,
                 String schemaName,
                 List<IProperty> properties,
                 List<Relationship> relationships)

Method Detail

getId

public String getId()

Description copied from class: AbstractAsset

Gets the identifier of this Asset

Specified by:

getId in interface IAsset

Overrides:

getId in class AbstractAsset

Returns:

the identifier of this Asset

setId

public void setId(String id)

Overrides:

setId in class AbstractAsset

getRequired

public String[] getRequired()

setRequired

public void setRequired(String[] required)

getSchemaName

public String getSchemaName()

Gets the name of schema in which this datamodel resides in.

Specified by:

getSchemaName in interface IDataModel

Returns:

the schema name in which this datamodel resides in.

setSchemaName

public void setSchemaName(String schemaName)

getProperties

public List<IProperty> getProperties()

Gets the properties of this datamodel.

Specified by:

getProperties in interface IDataModel

Returns:

the properties of this datamodel.

setProperties

public void setProperties(List<? extends IProperty> properties)

Sets the properties of this datamodel.

Specified by:

setProperties in interface IDataModel

Parameters:

properties - the properties of this datamodel.

addProperties

public void addProperties(List<IProperty> addProperties)

getRelationships

public List<Relationship> getRelationships()

getRelationships

public List<Relationship> getRelationships(IDataModel otherDataModel)

Gets relationships between this dataModel and another dataModel.

Specified by:

getRelationships in interface IDataModel

Parameters:

otherDataModel - another datamodel for which to find relationships to and from.

Returns:

an array of relationsips between this and the other datamodel.

isRootEntity

public boolean isRootEntity()

Description copied from interface: IDataModel

RootEntity is true if it is either an argument or return type of an operation

Specified by:

isRootEntity in interface IDataModel

Returns:

setRootEntity

public void setRootEntity(boolean value)

Specified by:

setRootEntity in interface IDataModel

setRelationships

public void setRelationships(List<Relationship> relationships)

getPropertyNames

public String[] getPropertyNames()

Gets the names of this datamodel's properties.

Returns:

an array of property names.

getPropertyByName

public IProperty getPropertyByName(String propertyName)

Convenience method for retrieving a property by it's name.

Parameters:

propertyName - the name of the property to retrieve

Returns:

the property with the given name. Returns null if no such property is found.

getPrimaryKeys

public IProperty[] getPrimaryKeys()

Gets the properties of this datamodel that are known to be primary keys. See IProperty.isPrimaryKey().

Returns:

an array of properties that are known to be primary keys.

addProperty

public void addProperty(IProperty property)

Add property to data model

Parameters:

property -

addAssociation

public void addAssociation(PropertyType associationType,
                           String name,
                           IDataModel dataModel)
                    throws DermisException

Add the associated datamodel

Parameters:

associationType - association type either COLLECTION or OBJECT

name - name of the property

dataModel - associated data model

Throws:

DermisException

isBinaryEntity

public boolean isBinaryEntity()

Specified by:

isBinaryEntity in interface IDataModel

setBinaryEntity

public void setBinaryEntity(boolean binaryEntity)

Specified by:

setBinaryEntity in interface IDataModel

isDefaultBinaryEntity

public boolean isDefaultBinaryEntity()

Specified by:

isDefaultBinaryEntity in interface IDataModel

setDefaultBinaryEntity

public void setDefaultBinaryEntity(boolean defaultBinaryEntity)

Specified by:

setDefaultBinaryEntity in interface IDataModel

isGenericOperationAllowed

public boolean isGenericOperationAllowed()

Flag represents whether this entity can be bind with generic operations

Specified by:

isGenericOperationAllowed in interface IDataModel

Returns:

- Return true if generic operation are allowed.

setGenericOperationAllowed

public void setGenericOperationAllowed(boolean genericOperationAllowed)

Set true if generic operations are allowed in this dataModel.

Parameters:

genericOperationAllowed -