public class RqlStatement
extends java.lang.Object
implements java.io.Serializable
This represents a single RqlStatement, which contains a query, an order by clause, a range clause, and a property hints clause.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION |
Constructor and Description |
---|
RqlStatement(atg.repository.rql.RqlQuery pQuery,
atg.repository.rql.OrderByClause pOrderBy,
atg.repository.rql.RangeClause pRange,
atg.repository.rql.PropertyHintsClause pPropertyHints) |
Modifier and Type | Method and Description |
---|---|
int |
executeCountQuery(RepositoryView pView,
java.lang.Object[] pParams)
Executes the query represented by this RqlStatement and returns
the number of results in the result set.
|
RepositoryItem[] |
executeQuery(RepositoryView pView,
java.lang.Object[] pParams)
Executes the query represented by this RqlStatement, including
the sorting, range and property hints clauses, and returns the
results.
|
RepositoryItem[] |
executeQueryUncached(RepositoryView pView,
java.lang.Object[] pParams)
Executes the query represented by this RqlStatement, including
the sorting, range and property hints clauses, and returns the
results.
|
atg.repository.rql.OrderByClause |
getOrderBy() |
atg.repository.rql.PropertyHintsClause |
getPropertyHints() |
atg.repository.rql.RqlQuery |
getQuery() |
atg.repository.rql.RangeClause |
getRange() |
static void |
main(java.lang.String[] pArgs)
This reads an RQL statement from an input file, the prints the
RQL statement back out again.
|
static RqlStatement |
parseRqlStatement(java.io.InputStream pIn)
Parses an RqlStatement from the specified input stream.
|
static RqlStatement |
parseRqlStatement(java.io.Reader pIn)
Parses an RqlStatement from the specified Reader.
|
static RqlStatement |
parseRqlStatement(java.lang.String pStatement)
Parses an RqlStatement from the given String.
|
static RqlStatement |
parseRqlStatement(java.lang.String pStatement,
boolean pCacheRqlStatement)
Parses an RqlStatement from the given String.
|
java.lang.String |
toString()
Returns a String representation of this
|
public RqlStatement(atg.repository.rql.RqlQuery pQuery, atg.repository.rql.OrderByClause pOrderBy, atg.repository.rql.RangeClause pRange, atg.repository.rql.PropertyHintsClause pPropertyHints)
public atg.repository.rql.RqlQuery getQuery()
public atg.repository.rql.OrderByClause getOrderBy()
public atg.repository.rql.RangeClause getRange()
public atg.repository.rql.PropertyHintsClause getPropertyHints()
public RepositoryItem[] executeQuery(RepositoryView pView, java.lang.Object[] pParams) throws RepositoryException
RepositoryException
public RepositoryItem[] executeQueryUncached(RepositoryView pView, java.lang.Object[] pParams) throws RepositoryException
RepositoryException
public int executeCountQuery(RepositoryView pView, java.lang.Object[] pParams) throws RepositoryException
RepositoryException
public static RqlStatement parseRqlStatement(java.io.InputStream pIn) throws RepositoryException
RepositoryException
public static RqlStatement parseRqlStatement(java.io.Reader pIn) throws RepositoryException
RepositoryException
public static RqlStatement parseRqlStatement(java.lang.String pStatement) throws RepositoryException
RepositoryException
public static RqlStatement parseRqlStatement(java.lang.String pStatement, boolean pCacheRqlStatement) throws RepositoryException
pCacheRqlStatement
is true, then the RqlStatement
that is created from this operation will be saved in an internal
cache with the String pStatement
as the key. The next
time this same string is passed to parseRqlStatement
,
the cached RqlStatement will be returned, so we don't have to
re-parse the same string over and over again. Only use this method
for statements that you'll definitely be re-using over again, and
if the code you're using does NOT cache the statement alreadypStatement
- the rql String to parsepCacheRqlStatement
- if true, this RqlStatement will be cached
in an internal cacheRepositoryException
- if an error occurs while parsing
the rql stringpublic java.lang.String toString()
toString
in class java.lang.Object
public static void main(java.lang.String[] pArgs) throws java.io.IOException, RepositoryException
java.io.IOException
RepositoryException