com.semarchy.mdm.runtime.model.dataaccess
Interface IView

All Known Implementing Classes:
DelegatingView

public interface IView

Represents a View for accessing Data.

Author:
sarod

Method Summary
 boolean containsAttribute(String pName)
           
 IViewAttribute<? extends IAttribute> getAttribute(String pName)
           
 List<IViewAttribute<? extends IAttribute>> getAttributes()
          Return the list of IViewAttribute of this view.
 String getClassNameExpression()
           
 List<OrderByExpression> getDefaultOrderBy()
           
 List<IViewAttribute<?>> getDNAttributes()
           
 String getDNSeparator()
           
 IEntity getEntity()
           
 FromClause getFromClause()
           
 ILineageNode getLineageNode(String pName)
           
 List<ILineageNode> getLineageNodes()
           
 IManyToOneNode getManyToOneNode(String pName)
          Get the ManyToOneNode by name.
 List<IManyToOneNode> getManyToOneNodes()
          Obtain the list of outgoing ManyToOne navigation nodes
 INavigationNode getNavigationNode(String navigationNodeName)
           
 Binding getObjectByIDBinding()
           
 IOneToManyNode getOneToManyNode(String pName)
          Get the IOneToManyNode by name.
 List<IOneToManyNode> getOneToManyNodes()
           
 String getViewName()
           
 String getViewType()
           
 String getWhereClause()
           
 boolean isStandard()
          Indicates whether view is standard (can be used with standard IDataManager.
 boolean isSubViewOf(IView otherView)
          Return true if this view and otherView have the same view type and if the IEntity of otherView is equals or parent of the entity of this view
 

Method Detail

getEntity

IEntity getEntity()

getViewName

String getViewName()

getViewType

String getViewType()

getFromClause

FromClause getFromClause()

getWhereClause

String getWhereClause()

getAttributes

List<IViewAttribute<? extends IAttribute>> getAttributes()
Return the list of IViewAttribute of this view. The list order is defined by the integration template however it's a good practice that the template tries to keep as much as possible the order defined in design time.

Returns:
the list of IViewAttribute

getAttribute

IViewAttribute<? extends IAttribute> getAttribute(String pName)
                                                  throws NoSuchViewAttributeException
Throws:
NoSuchViewAttributeException

containsAttribute

boolean containsAttribute(String pName)

getManyToOneNodes

List<IManyToOneNode> getManyToOneNodes()
Obtain the list of outgoing ManyToOne navigation nodes

Returns:

getManyToOneNode

IManyToOneNode getManyToOneNode(String pName)
                                throws NoSuchNavigationNodeException
Get the ManyToOneNode by name.

Parameters:
pName - the name is typically retrieve from IReference.getToRoleName()
Returns:
Throws:
NoSuchNavigationNodeException

getOneToManyNodes

List<IOneToManyNode> getOneToManyNodes()

getOneToManyNode

IOneToManyNode getOneToManyNode(String pName)
                                throws NoSuchNavigationNodeException
Get the IOneToManyNode by name.

Parameters:
pName - the name is typically retrieved from IReference.getFromRoleName()
Returns:
Throws:
NoSuchNavigationNodeException

getDNAttributes

List<IViewAttribute<?>> getDNAttributes()

getDNSeparator

String getDNSeparator()

getObjectByIDBinding

Binding getObjectByIDBinding()
Returns:
the binding used to get an object by ID

getDefaultOrderBy

List<OrderByExpression> getDefaultOrderBy()
Returns:
a non null order by expression list that acts as the default order by. List can be empty.

getClassNameExpression

String getClassNameExpression()
Returns:
the SQL expression used to get the class name value

getLineageNodes

List<ILineageNode> getLineageNodes()
Returns:
the list of all lineage nodes defined on this view

getLineageNode

ILineageNode getLineageNode(String pName)
                            throws NoSuchNavigationNodeException
Parameters:
pName -
Returns:
a lineage node given its unique name within this view
Throws:
NoSuchNavigationNodeException - if node is not found

isStandard

boolean isStandard()
Indicates whether view is standard (can be used with standard IDataManager.

Returns:

isSubViewOf

boolean isSubViewOf(IView otherView)
Return true if this view and otherView have the same view type and if the IEntity of otherView is equals or parent of the entity of this view

Parameters:
otherView -
Returns:

getNavigationNode

INavigationNode getNavigationNode(String navigationNodeName)


Copyright © 2015. All Rights Reserved.