com.semarchy.mdm.runtime.data
Class DataQuery

java.lang.Object
  extended by com.semarchy.mdm.runtime.data.DataQuery
All Implemented Interfaces:
Cloneable

public class DataQuery
extends Object
implements Cloneable

This class represents a Data Query used to query Data from the MDM Hub.

Author:
sarod

Constructor Summary
DataQuery(IView pView)
          Creates a Data Query using the given IView as the source of data.
DataQuery(IView pView, Long pLoadID)
          Alias for new DataQuery(new QuerySource(pView, pLoadID))
DataQuery(QuerySource pQuerySource)
          Creates a Query using the given IView as the source of data and binding the given pLoadID.
 
Method Summary
 void addGroupByExpression(String pGroupByExpression)
          Add a SemQL Expression to the list of Group By Expressions
 void addOrderByCriteria(String pOrderExpression)
           
 void addOrderByCriteria(String pOrderExpression, boolean pDescending)
           
 void addSelectExpression(String pSelectExpression)
          Add a SemQL Expression to the list of selected expressions
 DataQuery clone()
           
 Map<String,Object> getBindings()
           
 List<String> getGroupByExpressions()
          Returns the list of GroupBy expressions
 String getHavingCondition()
           
 List<OrderByCriteria> getOrderByCriterias()
           
 PageCriteria getPageCriteria()
           
 QuerySource getQuerySource()
           
 List<String> getSelectExpressions()
          Returns the list of selected select expressions
 Boolean getUseDefaultOrderBy()
           
 IView getView()
          Shortcut to getQuerySource().getView()
 String getWhereCondition()
           
 void removeBinding(String pBindingName)
           
 void setBinding(String pBindingName, Object pValue)
           
 void setBindings(Map<String,Object> pBindings)
           
 void setGroupByExpressions(List<String> pGroupByExpressions)
          Set the list of Group By Expressions
 void setHavingCondition(String pHavingCondition)
           
 void setOrderByCriterias(List<OrderByCriteria> pOrderByCriterias)
           
 void setPageCriteria(PageCriteria pPageCriteria)
           
 void setSelectExpressions(List<String> pSelectExpressions)
          Set the list of SemQL Expression
 void setUseDefaultOrderBy(Boolean pUseDefaultOrderBy)
          Defines whether to use the view IView.getDefaultOrderBy() as additional order by.
 void setWhereCondition(String pWhereCondition)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DataQuery

public DataQuery(IView pView)
Creates a Data Query using the given IView as the source of data.

Parameters:
pView -

DataQuery

public DataQuery(IView pView,
                 Long pLoadID)
Alias for new DataQuery(new QuerySource(pView, pLoadID))

Parameters:
pView -
pLoadID -

DataQuery

public DataQuery(QuerySource pQuerySource)
Creates a Query using the given IView as the source of data and binding the given pLoadID.

Parameters:
pView -
pLoadID - the LoadID required to query DataAccessModelConstants.SDE_VIEW_TYPE or DataAccessModelConstants.SDL_VIEW_TYPE views
Method Detail

addSelectExpression

public void addSelectExpression(String pSelectExpression)
Add a SemQL Expression to the list of selected expressions

Parameters:
pSelectExpression -

setSelectExpressions

public void setSelectExpressions(List<String> pSelectExpressions)
Set the list of SemQL Expression

Parameters:
pSelectExpressions -

getSelectExpressions

public List<String> getSelectExpressions()
Returns the list of selected select expressions

Returns:

addOrderByCriteria

public void addOrderByCriteria(String pOrderExpression)

addOrderByCriteria

public void addOrderByCriteria(String pOrderExpression,
                               boolean pDescending)

setOrderByCriterias

public void setOrderByCriterias(List<OrderByCriteria> pOrderByCriterias)

getOrderByCriterias

public List<OrderByCriteria> getOrderByCriterias()

setWhereCondition

public void setWhereCondition(String pWhereCondition)

getWhereCondition

public String getWhereCondition()

setHavingCondition

public void setHavingCondition(String pHavingCondition)

getHavingCondition

public String getHavingCondition()

addGroupByExpression

public void addGroupByExpression(String pGroupByExpression)
Add a SemQL Expression to the list of Group By Expressions

Parameters:
pGroupByExpression -

setGroupByExpressions

public void setGroupByExpressions(List<String> pGroupByExpressions)
Set the list of Group By Expressions

Parameters:
pGroupByExpressions -

getGroupByExpressions

public List<String> getGroupByExpressions()
Returns the list of GroupBy expressions

Returns:

setBinding

public void setBinding(String pBindingName,
                       Object pValue)

removeBinding

public void removeBinding(String pBindingName)

getBindings

public Map<String,Object> getBindings()

setBindings

public void setBindings(Map<String,Object> pBindings)

setPageCriteria

public void setPageCriteria(PageCriteria pPageCriteria)

getPageCriteria

public PageCriteria getPageCriteria()

getQuerySource

public QuerySource getQuerySource()

getView

public IView getView()
Shortcut to getQuerySource().getView()

Returns:

toString

public String toString()
Overrides:
toString in class Object

getUseDefaultOrderBy

public Boolean getUseDefaultOrderBy()
Returns:
See Also:
setUseDefaultOrderBy(Boolean)

setUseDefaultOrderBy

public void setUseDefaultOrderBy(Boolean pUseDefaultOrderBy)
Defines whether to use the view IView.getDefaultOrderBy() as additional order by. This ensures that pagination is consistent but can make the queries slower. Default value is null

Parameters:
pUseDefaultOrderBy -

clone

public DataQuery clone()
Overrides:
clone in class Object


Copyright © 2015. All Rights Reserved.