AR System Java API

com.bmc.arsys.api
Class RecursiveQuery

java.lang.Object
  extended by com.bmc.arsys.api.QueryBase
      extended by com.bmc.arsys.api.RecursiveQuery
All Implemented Interfaces:
IQuerySource, Cloneable

public class RecursiveQuery
extends QueryBase
implements IQuerySource, Cloneable

The RecursiveQuery class is used to define the properties of a sub- or hierarchical query.

See Also:
QueryBase, IQuerySource, QuerySourceForm

Field Summary
 
Fields inherited from interface com.bmc.arsys.api.IQuerySource
AR_MULTI_SCHEMA_JOIN_INNER, AR_MULTI_SCHEMA_JOIN_LEFT, AR_MULTI_SCHEMA_JOIN_NONE, AR_MULTI_SCHEMA_JOIN_RIGHT
 
Constructor Summary
RecursiveQuery()
           
RecursiveQuery(IQuerySource sourceJoinedWith, int joinType, QualifierInfo joinQualifier, QualifierInfo startQualifier, QualifierInfo recursionQualifier, int levelsToRetrieve)
           
RecursiveQuery(QualifierInfo recursionQualifier, int levelsToRetrieve)
           
 
Method Summary
 boolean addFromSource(QuerySourceForm sourceForm, boolean isRecursive)
          Adds a new form to the list of the IQuerySource sources that the recursive query selects from.
 Object clone()
          Clone implementation that returns an Object with data cloned from self.
 boolean equals(Object obj)
           
 String getAlias()
          Internal use.
 IQuerySource getJoinedWith()
          Returns the IQuerySource source this source is joined with.
 QualifierInfo getJoinQualifier()
          Returns the join qualifier.
 int getJoinType()
          Returns the type of a join.
 int getLevelsToRetrieve()
          Gets the levels to retrieve.
 QualifierInfo getQualifier()
          Returns the start qualifier.
 QualifierInfo getRecursionQualifier()
          Returns the recursion qualifier.
 QuerySourceForm getRecursiveForm()
          Returns the recursive form.
 int hashCode()
           
 void setJoin(IQuerySource sourceJoinedWith, int joinType, QualifierInfo joinQualifier)
          Sets the join information.
 void setJoinedWith(IQuerySource sourceJoinedWith)
          Sets the IQuerySource source to be joined with.
 void setJoinQualifier(QualifierInfo joinQualifier)
          Sets the join qualifier.
 void setJoinType(int joinType)
          Sets the type of a join.
 void setLevelsToRetrieve(int levelsToRetrieve)
          Sets the levels to retrieve.
 void setQualifier(QualifierInfo startQualifier)
          Sets the start qualifier.
 void setRecursionQualifier(QualifierInfo recursionQualifier)
          Sets the recursion qualifier.
 void setRecursiveForm(QuerySourceForm recursiveForm)
          Sets the recursive form.
 String toString()
          Returns a string description of the object.
 String toStringShort()
          Returns a simplified string description of the object.
 
Methods inherited from class com.bmc.arsys.api.QueryBase
addFromField, addFromField, addFromField, addFromSource, addGroupBy, addHaving, getFromFields, getFromSources, getGroupBy, getHaving, getHavingList, setFromFields, setFromSources, setGroupBy, setHaving
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RecursiveQuery

public RecursiveQuery()

RecursiveQuery

public RecursiveQuery(QualifierInfo recursionQualifier,
                      int levelsToRetrieve)

RecursiveQuery

public RecursiveQuery(IQuerySource sourceJoinedWith,
                      int joinType,
                      QualifierInfo joinQualifier,
                      QualifierInfo startQualifier,
                      QualifierInfo recursionQualifier,
                      int levelsToRetrieve)
Method Detail

setJoin

public void setJoin(IQuerySource sourceJoinedWith,
                    int joinType,
                    QualifierInfo joinQualifier)
Sets the join information.


getJoinQualifier

public QualifierInfo getJoinQualifier()
Returns the join qualifier.

Specified by:
getJoinQualifier in interface IQuerySource

setJoinQualifier

public void setJoinQualifier(QualifierInfo joinQualifier)
Sets the join qualifier.

Specified by:
setJoinQualifier in interface IQuerySource

getJoinType

public int getJoinType()
Returns the type of a join.

Specified by:
getJoinType in interface IQuerySource

setJoinType

public void setJoinType(int joinType)
Sets the type of a join.

Specified by:
setJoinType in interface IQuerySource

getJoinedWith

public IQuerySource getJoinedWith()
Returns the IQuerySource source this source is joined with.

Specified by:
getJoinedWith in interface IQuerySource

setJoinedWith

public void setJoinedWith(IQuerySource sourceJoinedWith)
Sets the IQuerySource source to be joined with.

Specified by:
setJoinedWith in interface IQuerySource
See Also:
QuerySourceForm.setJoin(com.bmc.arsys.api.IQuerySource, int, com.bmc.arsys.api.QualifierInfo)

setRecursionQualifier

public void setRecursionQualifier(QualifierInfo recursionQualifier)
Sets the recursion qualifier.


getRecursionQualifier

public QualifierInfo getRecursionQualifier()
Returns the recursion qualifier.


setLevelsToRetrieve

public void setLevelsToRetrieve(int levelsToRetrieve)
Sets the levels to retrieve.


getLevelsToRetrieve

public int getLevelsToRetrieve()
Gets the levels to retrieve.


setQualifier

public void setQualifier(QualifierInfo startQualifier)
Sets the start qualifier.

Overrides:
setQualifier in class QueryBase

getQualifier

public QualifierInfo getQualifier()
Returns the start qualifier.

Overrides:
getQualifier in class QueryBase

setRecursiveForm

public void setRecursiveForm(QuerySourceForm recursiveForm)
Sets the recursive form.


getRecursiveForm

public QuerySourceForm getRecursiveForm()
Returns the recursive form.


addFromSource

public boolean addFromSource(QuerySourceForm sourceForm,
                             boolean isRecursive)
Adds a new form to the list of the IQuerySource sources that the recursive query selects from. If specified, sets this form as the form to recurse on.


getAlias

public String getAlias()
Internal use.

Specified by:
getAlias in interface IQuerySource

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

clone

public Object clone()
             throws CloneNotSupportedException
Clone implementation that returns an Object with data cloned from self.

Specified by:
clone in interface IQuerySource
Overrides:
clone in class QueryBase
Throws:
CloneNotSupportedException

toString

public String toString()
Returns a string description of the object.

Overrides:
toString in class QueryBase

toStringShort

public String toStringShort()
Returns a simplified string description of the object. Used for API logging.

Specified by:
toStringShort in interface IQuerySource

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.