it.eng.qbe.query
Interface IQuery

All Known Implementing Classes:
Query

public interface IQuery

The Interface IQuery.


Method Summary
 CalculatedField addCalculatedField(java.lang.String fieldId, java.lang.String fieldNameInQuery, java.lang.String classNameInQuery, Formula formula, IHibernateDataSource dataSource)
          Adds the calculated field.
 void addEntityClass(EntityClass ec)
          Adds the entity class.
 IGroupByField addGroupByField(java.lang.String fieldName)
          Adds the group by field.
 IOrderByField addOrderByField(java.lang.String fieldName)
          Adds the order by field.
 ISelectField addSelectField(java.lang.String className, java.lang.String fieldName, java.lang.String fieldLabel, java.lang.String fieldHibType, java.lang.String fieldHibScale, java.lang.String fieldHibPrec)
          Adds the select field.
 IWhereField addWhereField(java.lang.String fieldName, java.lang.String type)
          Adds the where field.
 boolean areAllEntitiesJoined()
          Are all entities joined.
 boolean containEntityClass(EntityClass ec)
          Contain entity class.
 boolean containsDuplicatedAliases()
          Contains duplicated aliases.
 void deleteCalculatedField(java.lang.String fieldId)
          Delete calculated field.
 void deleteGroupByClause()
          Delete group by clause.
 void deleteGroupByField(java.lang.String fieldId)
          Delete group by field.
 void deleteOrderByClause()
          Delete order by clause.
 void deleteOrderByField(java.lang.String fieldId)
          Delete order by field.
 void deleteSelectClause()
          Delete select clause.
 void deleteSelectField(java.lang.String fieldId)
          Delete select field.
 void deleteWhereClause()
          Delete where clause.
 void deleteWhereField(java.lang.String fieldId)
          Delete where field.
 void deselectSubquery()
          Deselect subquery.
 java.lang.Integer findPositionOf(java.lang.String completeName)
          Find position of.
 java.util.Iterator getCalculatedFieldsIterator()
          Gets the calculated fields iterator.
 IQuery getCopy()
          Gets the copy.
 boolean getDistinct()
          Gets the distinct.
 java.lang.String[] getDuplicatedAliases()
          Gets the duplicated aliases.
 java.util.Iterator getEntityClassesIterator()
          Gets the entity classes iterator.
 java.lang.String getErrMsg()
          Gets the err msg.
 java.util.Iterator getGroupByFieldsIterator()
          Gets the group by fields iterator.
 java.util.Iterator getOrderByFieldsIterator()
          Gets the order by fields iterator.
 java.lang.String getQueryId()
          Gets the query id.
 java.util.Iterator getSelectFieldsIterator()
          Gets the select fields iterator.
 IQuery getSubquery(java.lang.String fieldId)
          Gets the subquery.
 java.lang.String getSubqueryErrMsg(java.lang.String fieldId)
          Gets the subquery err msg.
 java.lang.String getSubqueryField()
          Deprecated. use getSubqueryFieldId
 java.lang.String getSubqueryFieldId()
          Gets the subquery field id.
 java.lang.String getSubQueryIdForSubQueryOnField(java.lang.String fieldId)
          Gets the sub query id for sub query on field.
 java.util.Iterator getWhereFieldsIterator()
          Gets the where fields iterator.
 boolean isEmpty()
          Checks if is empty.
 boolean isSelectedSubqueryValid()
          Checks if is selected subquery valid.
 boolean isSubqueryModeActive()
          Checks if is subquery mode active.
 boolean isSubqueryValid(IQuery subquery)
          Checks if is subquery valid.
 void moveDownGroupByField(java.lang.String fieldId)
          Move down group by field.
 void moveDownOrderByField(java.lang.String fieldId)
          Move down order by field.
 void moveDownSelectField(java.lang.String fieldId)
          Move down select field.
 void moveDownWhereField(java.lang.String fieldId)
          Move down where field.
 void moveUpGroupByField(java.lang.String fieldId)
          Move up group by field.
 void moveUpOrderByField(java.lang.String fieldId)
          Move up order by field.
 void moveUpSelectField(java.lang.String fieldId)
          Move up select field.
 void moveUpWhereField(java.lang.String fieldId)
          Move up where field.
 void purgeNotReferredEntityClasses()
          Purge not referred entity classes.
 void purgeNotReferredEntityClasses(java.lang.String prefix)
          Purge not referred entity classes.
 void saveSelectedSubquery()
          Save selected subquery.
 void selectSubquery(java.lang.String fieldId)
          Select subquery.
 void setDistinct(boolean distinct)
          Sets the distinct.
 void setErrMsg(java.lang.String errMsg)
          Sets the err msg.
 void setQueryId(java.lang.String queryId)
          Sets the query id.
 void switchAscendingOrderPopertyValue(java.lang.String fieldId)
          Switch ascending order poperty value.
 

Method Detail

getQueryId

java.lang.String getQueryId()
Gets the query id.

Returns:
the query id

setQueryId

void setQueryId(java.lang.String queryId)
Sets the query id.

Parameters:
queryId - the new query id

deleteSelectClause

void deleteSelectClause()
Delete select clause.


deleteSelectField

void deleteSelectField(java.lang.String fieldId)
Delete select field.

Parameters:
fieldId - the field id

deleteCalculatedField

void deleteCalculatedField(java.lang.String fieldId)
Delete calculated field.

Parameters:
fieldId - the field id

getSelectFieldsIterator

java.util.Iterator getSelectFieldsIterator()
Gets the select fields iterator.

Returns:
the select fields iterator

getCalculatedFieldsIterator

java.util.Iterator getCalculatedFieldsIterator()
Gets the calculated fields iterator.

Returns:
the calculated fields iterator

addSelectField

ISelectField addSelectField(java.lang.String className,
                            java.lang.String fieldName,
                            java.lang.String fieldLabel,
                            java.lang.String fieldHibType,
                            java.lang.String fieldHibScale,
                            java.lang.String fieldHibPrec)
Adds the select field.

Parameters:
className - the class name
fieldName - the field name
fieldLabel - the field label
fieldHibType - the field hib type
fieldHibScale - the field hib scale
fieldHibPrec - the field hib prec
Returns:
the i select field

addCalculatedField

CalculatedField addCalculatedField(java.lang.String fieldId,
                                   java.lang.String fieldNameInQuery,
                                   java.lang.String classNameInQuery,
                                   Formula formula,
                                   IHibernateDataSource dataSource)
Adds the calculated field.

Parameters:
fieldId - the field id
fieldNameInQuery - the field name in query
classNameInQuery - the class name in query
formula - the formula
dataSource - the data source
Returns:
the calculated field

moveDownSelectField

void moveDownSelectField(java.lang.String fieldId)
Move down select field.

Parameters:
fieldId - the field id

moveUpSelectField

void moveUpSelectField(java.lang.String fieldId)
Move up select field.

Parameters:
fieldId - the field id

getEntityClassesIterator

java.util.Iterator getEntityClassesIterator()
Gets the entity classes iterator.

Returns:
the entity classes iterator

containEntityClass

boolean containEntityClass(EntityClass ec)
Contain entity class.

Parameters:
ec - the ec
Returns:
true, if successful

addEntityClass

void addEntityClass(EntityClass ec)
Adds the entity class.

Parameters:
ec - the ec

purgeNotReferredEntityClasses

void purgeNotReferredEntityClasses()
Purge not referred entity classes.


purgeNotReferredEntityClasses

void purgeNotReferredEntityClasses(java.lang.String prefix)
Purge not referred entity classes.

Parameters:
prefix - the prefix

deleteWhereClause

void deleteWhereClause()
Delete where clause.


deleteWhereField

void deleteWhereField(java.lang.String fieldId)
Delete where field.

Parameters:
fieldId - the field id

getWhereFieldsIterator

java.util.Iterator getWhereFieldsIterator()
Gets the where fields iterator.

Returns:
the where fields iterator

addWhereField

IWhereField addWhereField(java.lang.String fieldName,
                          java.lang.String type)
Adds the where field.

Parameters:
fieldName - the field name
type - the type
Returns:
the i where field

moveDownWhereField

void moveDownWhereField(java.lang.String fieldId)
Move down where field.

Parameters:
fieldId - the field id

moveUpWhereField

void moveUpWhereField(java.lang.String fieldId)
Move up where field.

Parameters:
fieldId - the field id

deleteGroupByClause

void deleteGroupByClause()
Delete group by clause.


deleteGroupByField

void deleteGroupByField(java.lang.String fieldId)
Delete group by field.

Parameters:
fieldId - the field id

addGroupByField

IGroupByField addGroupByField(java.lang.String fieldName)
Adds the group by field.

Parameters:
fieldName - the field name
Returns:
the i group by field

getGroupByFieldsIterator

java.util.Iterator getGroupByFieldsIterator()
Gets the group by fields iterator.

Returns:
the group by fields iterator

moveDownGroupByField

void moveDownGroupByField(java.lang.String fieldId)
Move down group by field.

Parameters:
fieldId - the field id

moveUpGroupByField

void moveUpGroupByField(java.lang.String fieldId)
Move up group by field.

Parameters:
fieldId - the field id

deleteOrderByClause

void deleteOrderByClause()
Delete order by clause.


deleteOrderByField

void deleteOrderByField(java.lang.String fieldId)
Delete order by field.

Parameters:
fieldId - the field id

addOrderByField

IOrderByField addOrderByField(java.lang.String fieldName)
Adds the order by field.

Parameters:
fieldName - the field name
Returns:
the i order by field

getOrderByFieldsIterator

java.util.Iterator getOrderByFieldsIterator()
Gets the order by fields iterator.

Returns:
the order by fields iterator

moveDownOrderByField

void moveDownOrderByField(java.lang.String fieldId)
Move down order by field.

Parameters:
fieldId - the field id

moveUpOrderByField

void moveUpOrderByField(java.lang.String fieldId)
Move up order by field.

Parameters:
fieldId - the field id

switchAscendingOrderPopertyValue

void switchAscendingOrderPopertyValue(java.lang.String fieldId)
Switch ascending order poperty value.

Parameters:
fieldId - the field id

setDistinct

void setDistinct(boolean distinct)
Sets the distinct.

Parameters:
distinct - the new distinct

getDistinct

boolean getDistinct()
Gets the distinct.

Returns:
the distinct

selectSubquery

void selectSubquery(java.lang.String fieldId)
Select subquery.

Parameters:
fieldId - the field id

getSubquery

IQuery getSubquery(java.lang.String fieldId)
Gets the subquery.

Parameters:
fieldId - the field id
Returns:
the subquery

getSubQueryIdForSubQueryOnField

java.lang.String getSubQueryIdForSubQueryOnField(java.lang.String fieldId)
Gets the sub query id for sub query on field.

Parameters:
fieldId - the field id
Returns:
the sub query id for sub query on field

getDuplicatedAliases

java.lang.String[] getDuplicatedAliases()
Gets the duplicated aliases.

Returns:
the duplicated aliases

containsDuplicatedAliases

boolean containsDuplicatedAliases()
Contains duplicated aliases.

Returns:
true, if successful

isEmpty

boolean isEmpty()
Checks if is empty.

Returns:
true, if is empty

areAllEntitiesJoined

boolean areAllEntitiesJoined()
Are all entities joined.

Returns:
true, if successful

getErrMsg

java.lang.String getErrMsg()
Gets the err msg.

Returns:
the err msg

getSubqueryErrMsg

java.lang.String getSubqueryErrMsg(java.lang.String fieldId)
Gets the subquery err msg.

Parameters:
fieldId - the field id
Returns:
the subquery err msg

setErrMsg

void setErrMsg(java.lang.String errMsg)
Sets the err msg.

Parameters:
errMsg - the new err msg

getCopy

IQuery getCopy()
Gets the copy.

Returns:
the copy

findPositionOf

java.lang.Integer findPositionOf(java.lang.String completeName)
Find position of.

Parameters:
completeName - the complete name
Returns:
the integer

isSubqueryValid

boolean isSubqueryValid(IQuery subquery)
Checks if is subquery valid.

Parameters:
subquery - the subquery
Returns:
true, if is subquery valid

isSelectedSubqueryValid

boolean isSelectedSubqueryValid()
Checks if is selected subquery valid.

Returns:
true, if is selected subquery valid

getSubqueryField

java.lang.String getSubqueryField()
Deprecated. use getSubqueryFieldId

Gets the subquery field.

Returns:
the subquery field

getSubqueryFieldId

java.lang.String getSubqueryFieldId()
Gets the subquery field id.

Returns:
the subquery field id

deselectSubquery

void deselectSubquery()
Deselect subquery.


saveSelectedSubquery

void saveSelectedSubquery()
Save selected subquery.


isSubqueryModeActive

boolean isSubqueryModeActive()
Checks if is subquery mode active.

Returns:
true, if is subquery mode active