com.semarchy.mdm.runtime.model.logical
Interface IEntity

All Superinterfaces:
IUniquelyNamed, Serializable

public interface IEntity
extends IUniquelyNamed, Serializable

Interface that defines the run-time shape of an entity

Author:
skamel

Field Summary
static String ENTITY_PREFIX
           
 
Fields inherited from interface com.semarchy.mdm.runtime.model.logical.IUniquelyNamed
SEP
 
Method Summary
 List<IEntityAttribute> getAllAttributesForPhysicalStorage()
          The list of all attributes as declared in this entity, all its super entities and ALL sub-entities.
 List<IEntity> getAllSubEntities()
           
 IEntityAttribute getAttribute(String pAttributeName)
           
 IAttributeGroup getAttributeGroup(String pGroupName)
          Deprecated. use IFormView and IFormSection instead
 List<IAttributeGroup> getAttributeGroups()
          Deprecated. use IFormView and IFormSection instead
 List<IEntityAttribute> getAttributes()
          The list of attributes declared in this entity or inherited from its super entities.
 IEntity getBaseEntity()
          Return the top base entity from which this entity inherits.
 ICheckConstraint getCheckConstraint(String pName)
           
 List<ICheckConstraint> getCheckConstraints()
           
 IConsolidator getConsolidator()
           
 IEntityAttribute getDeclaredAttribute(String pAttributeName)
           
 List<IEntityAttribute> getDeclaredAttributes()
          The list of attributes declared in this entity (not inherited) ordered by their position as defined in design model.
 IFormView getDefaultFormView()
          Get the default IFormView for this IEntity.
 ITableView getDefaultTableView()
          Get the default ITableView for this IEntity.
 List<IEntityAttribute> getDNAttributes()
           
 String getDNSeparator()
           
 IEnricher getEnricher(String pName)
           
 List<IEnricher> getEnrichers()
          Returns the list of IEnrichers ordered according to design position.
 IFormView getFormView(String pName)
          Return the IFormView with the given name or throws NoSuchFormViewException if there is no IFormView with this name
 List<IFormView> getFormViews()
          Obtain the list of IFormViews.
 IMatcher getMatcher()
           
 MatchingBehavior getMatchingBehavior()
          Return the MatchingBehavior for this IEntity.
 IModel getModel()
          Deprecated.  
 String getName()
           
 String getPhysicalName()
           
 IPKAttribute getPKAttribute()
          Obtain the primary key attribute for this IEntity.
 IPluginValidator getPluginValidator(String pName)
           
 List<IPluginValidator> getPluginValidators()
           
 IReference getReferencedRef(String pReferenceName)
           
 List<IReference> getReferencedRefs()
          Return the IReferences where this entity (or one of it's super entities) is the from entity.
 IReference getReferencingRef(String pReferenceName)
           
 List<IReference> getReferencingRefs()
          Return the IReferences where this entity (or one of it's super entities) is the to entity.
 IEntity getSuperEntity()
           
 ITableView getTableView(String pName)
          Return the ITableView with the given name or throws NoSuchTableViewException if there is no ITableView with this name
 List<ITableView> getTableViews()
          Obtain the list of ITableViews.
 IUniqueKey getUniqueKey(String pName)
           
 List<IUniqueKey> getUniqueKeys()
           
 IDTDataValidation getValidation(String pConstraintType, String pConstraintName)
          Retrieve the Constraint
 List<IDTDataValidation> getValidations()
          Returns the validationConstraints defined on this entity.
 boolean isFuzzy()
          Shortcut to getPKAttribute().getPKType().isSDPK()
 boolean isI18ned()
           
 boolean isPartOfInheritance()
          Returns true if current entity is part of an inheritance hierarchy.
 boolean isSDPK()
          Deprecated. since Convergence MDM 2.1 use isFuzzy() instead
 boolean isSubEntityOf(IEntity pOtherEntity)
          Returns true if current entity is the same or is a sub entity of the pOtherEntity
 
Methods inherited from interface com.semarchy.mdm.runtime.model.logical.IUniquelyNamed
getPrefixedUniqueName, getUniqueName
 

Field Detail

ENTITY_PREFIX

static final String ENTITY_PREFIX
See Also:
Constant Field Values
Method Detail

getModel

IModel getModel()
Deprecated. 

Returns:

getName

String getName()
Returns:
the entity name

getPhysicalName

String getPhysicalName()
Returns:
the physical name of the entity. i.e. the name of the physical table of the base entity without prefix

getPKAttribute

IPKAttribute getPKAttribute()
Obtain the primary key attribute for this IEntity. If the IEntity has a getSuperEntity() the IPKAttribute comes from the base IEntity

Returns:

getDeclaredAttributes

List<IEntityAttribute> getDeclaredAttributes()
The list of attributes declared in this entity (not inherited) ordered by their position as defined in design model.

Returns:
the list of attributes declared in this entity.
See Also:
getAttributes()

getDeclaredAttribute

IEntityAttribute getDeclaredAttribute(String pAttributeName)
                                      throws NoSuchAttributeException
Parameters:
pAttributeName -
Returns:
an entity attribute declared by this entity given its name
Throws:
NoSuchAttributeException - when the attribute name cannot be found or if it is null

getAttributes

List<IEntityAttribute> getAttributes()
The list of attributes declared in this entity or inherited from its super entities. The list is ordered first by entity hierarchy level (root ancestor entity first), then by attribute position as defined in the design model.

Returns:
the list of all attributes.

getAttribute

IEntityAttribute getAttribute(String pAttributeName)
                              throws NoSuchAttributeException
Parameters:
pAttributeName -
Returns:
an entity attribute given its name either declared in this entity or any of its super entities
Throws:
NoSuchAttributeException - when the attribute name cannot be found or if it is null

getAllAttributesForPhysicalStorage

List<IEntityAttribute> getAllAttributesForPhysicalStorage()
The list of all attributes as declared in this entity, all its super entities and ALL sub-entities. This is typically used to retrieve all attributes that will be stored in the same database table. The list is ordered first by inheritance hierarchy level (root ancestor entity first), then by attribute position as defined in the design model. Entities of the same level are ordered by entity name.

Returns:
the list of attributes
See Also:
getAttributes()

getSuperEntity

IEntity getSuperEntity()
Returns:
the entity from which this entity inherits or null if this is a top (base) entity

getAllSubEntities

List<IEntity> getAllSubEntities()
Returns:
the list of all sub-entities that extend this entity including this entity itself

isSubEntityOf

boolean isSubEntityOf(IEntity pOtherEntity)
Returns true if current entity is the same or is a sub entity of the pOtherEntity

Parameters:
pOtherEntity -
Returns:

isI18ned

boolean isI18ned()
Returns:
true if at least one attribute of the whole entity hierarchy is i18ned attribute, false otherwise

getReferencingRefs

List<IReference> getReferencingRefs()
Return the IReferences where this entity (or one of it's super entities) is the to entity.

Returns:
all referencing references for this entity including those inherited from its super entities

getReferencingRef

IReference getReferencingRef(String pReferenceName)
                             throws NoSuchReferenceException
Parameters:
pReferenceName -
Returns:
a referencing reference that matches reference name
Throws:
NoSuchReferenceException - if this reference is not found

getReferencedRefs

List<IReference> getReferencedRefs()
Return the IReferences where this entity (or one of it's super entities) is the from entity.

Returns:
all referenced references for this entity including those inherited from its super entities.

getReferencedRef

IReference getReferencedRef(String pReferenceName)
                            throws NoSuchReferenceException
Parameters:
pReferenceName -
Returns:
a referenced reference that matches the reference name
Throws:
NoSuchReferenceException - if this reference is not found

getDNAttributes

List<IEntityAttribute> getDNAttributes()

getDNSeparator

String getDNSeparator()

getAttributeGroups

List<IAttributeGroup> getAttributeGroups()
Deprecated. use IFormView and IFormSection instead

Returns:

getAttributeGroup

IAttributeGroup getAttributeGroup(String pGroupName)
                                  throws NoSuchAttributeGroupException
Deprecated. use IFormView and IFormSection instead

Parameters:
pGroupName -
Returns:
Throws:
NoSuchAttributeGroupException

getCheckConstraints

List<ICheckConstraint> getCheckConstraints()

getCheckConstraint

ICheckConstraint getCheckConstraint(String pName)
                                    throws NoSuchCheckConstraintException
Throws:
NoSuchCheckConstraintException

getUniqueKeys

List<IUniqueKey> getUniqueKeys()

getUniqueKey

IUniqueKey getUniqueKey(String pName)
                        throws NoSuchUniqueKeyException
Throws:
NoSuchUniqueKeyException

getEnrichers

List<IEnricher> getEnrichers()
Returns the list of IEnrichers ordered according to design position.

Returns:

getEnricher

IEnricher getEnricher(String pName)
                      throws NoSuchEnricherException
Throws:
NoSuchEnricherException

getMatcher

IMatcher getMatcher()

getConsolidator

IConsolidator getConsolidator()

getPluginValidators

List<IPluginValidator> getPluginValidators()

getPluginValidator

IPluginValidator getPluginValidator(String pName)
                                    throws NoSuchPluginValidatorException
Throws:
NoSuchPluginValidatorException

getTableViews

List<ITableView> getTableViews()
Obtain the list of ITableViews. The list is ordered based on ITableView names.

Returns:

getTableView

ITableView getTableView(String pName)
                        throws NoSuchTableViewException
Return the ITableView with the given name or throws NoSuchTableViewException if there is no ITableView with this name

Parameters:
pName -
Returns:
Throws:
NoSuchTableViewException

getDefaultTableView

ITableView getDefaultTableView()
Get the default ITableView for this IEntity.

Returns:

getFormViews

List<IFormView> getFormViews()
Obtain the list of IFormViews. The list is ordered based on IFormView names.

Returns:

getFormView

IFormView getFormView(String pName)
                      throws NoSuchFormViewException
Return the IFormView with the given name or throws NoSuchFormViewException if there is no IFormView with this name

Parameters:
pName -
Returns:
Throws:
NoSuchFormViewException

getDefaultFormView

IFormView getDefaultFormView()
Get the default IFormView for this IEntity.

Returns:

getMatchingBehavior

MatchingBehavior getMatchingBehavior()
Return the MatchingBehavior for this IEntity.

Returns:

isSDPK

boolean isSDPK()
Deprecated. since Convergence MDM 2.1 use isFuzzy() instead

Shortcut to getPKAttribute().getPKType().isSDPK()

Returns:

isFuzzy

boolean isFuzzy()
Shortcut to getPKAttribute().getPKType().isSDPK()

Returns:

getBaseEntity

IEntity getBaseEntity()
Return the top base entity from which this entity inherits. If this IEntity is the base Entity (it does not have a getSuperEntity()) it returns itself.

Returns:

isPartOfInheritance

boolean isPartOfInheritance()
Returns true if current entity is part of an inheritance hierarchy.

Returns:

getValidations

List<IDTDataValidation> getValidations()
Returns the validationConstraints defined on this entity. Ordered as they will be executed in Integration Job (though independently of ValidationScope) that is:


getValidation

IDTDataValidation getValidation(String pConstraintType,
                                String pConstraintName)
                                throws NoSuchConstraintException
Retrieve the Constraint

Parameters:
pConstraintType -
pConstraintName -
Returns:
Throws:
NoSuchConstraintException


Copyright © 2015. All Rights Reserved.