org.apache.chemistry.opencmis.client.runtime

Class QueryStatementImpl

java.lang.Object

org.apache.chemistry.opencmis.client.runtime.QueryStatementImpl

All Implemented Interfaces:

Cloneable, QueryStatement

public class QueryStatementImpl
extends Object
implements QueryStatement, Cloneable

QueryStatement implementation.

Constructor Summary

Constructors

Constructor and Description
QueryStatementImpl(Session session, Collection<String> selectPropertyIds, Map<String,String> fromTypes, String whereClause, List<String> orderByPropertyIds) Creates a QueryStatement object for a query of one primary type joined by zero or more secondary types.
QueryStatementImpl(Session session, String statement) Creates a QueryStatement object with a given statement.

Method Summary

Methods

Modifier and Type	Method and Description
protected QueryStatementImpl	clone()
ItemIterable<QueryResult>	query(boolean searchAllVersions) Executes the query.
ItemIterable<QueryResult>	query(boolean searchAllVersions, OperationContext context) Executes the query.
void	setBoolean(int parameterIndex, boolean... bool) Sets the designated parameter to the given boolean.
protected void	setDateTime(int parameterIndex, boolean prefix, Calendar... cal)
protected void	setDateTime(int parameterIndex, boolean prefix, Date... date)
protected void	setDateTime(int parameterIndex, boolean prefix, long... ms)
void	setDateTime(int parameterIndex, Calendar... cal) Sets the designated parameter to the given DateTime value.
void	setDateTime(int parameterIndex, Date... date) Sets the designated parameter to the given DateTime value.
void	setDateTime(int parameterIndex, long... ms) Sets the designated parameter to the given DateTime value.
void	setDateTimeTimestamp(int parameterIndex, Calendar... cal) Sets the designated parameter to the given DateTime value with the prefix 'TIMESTAMP '.
void	setDateTimeTimestamp(int parameterIndex, Date... date) Sets the designated parameter to the given DateTime value with the prefix 'TIMESTAMP '.
void	setDateTimeTimestamp(int parameterIndex, long... ms) Sets the designated parameter to the given DateTime value with the prefix 'TIMESTAMP '.
void	setId(int parameterIndex, ObjectId... id) Sets the designated parameter to the given object ID.
void	setNumber(int parameterIndex, Number... num) Sets the designated parameter to the given number.
void	setProperty(int parameterIndex, PropertyDefinition<?> propertyDefinition) Sets the designated parameter to the query name of the given property.
void	setProperty(int parameterIndex, String typeId, String propertyId) Sets the designated parameter to the query name of the given property.
void	setString(int parameterIndex, String... str) Sets the designated parameter to the given string.
void	setStringContains(int parameterIndex, String str) Sets the designated parameter to the given string in a CMIS contains statement.
void	setStringLike(int parameterIndex, String str) Sets the designated parameter to the given string.
void	setType(int parameterIndex, ObjectType type) Sets the designated parameter to the query name of the given type.
void	setType(int parameterIndex, String typeId) Sets the designated parameter to the query name of the given type ID.
void	setUri(int parameterIndex, URI... uri) Sets the designated parameter to the given URI.
void	setUrl(int parameterIndex, URL... url) Sets the designated parameter to the given URL.
String	toQueryString() Returns the query statement.
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryStatementImpl

public QueryStatementImpl(Session session,
                  String statement)

Creates a QueryStatement object with a given statement.

Parameters:

session - the Session object, must not be null

statement - the query statement with placeholders ('?'), see QueryStatement for details

QueryStatementImpl

public QueryStatementImpl(Session session,
                  Collection<String> selectPropertyIds,
                  Map<String,String> fromTypes,
                  String whereClause,
                  List<String> orderByPropertyIds)

Creates a QueryStatement object for a query of one primary type joined by zero or more secondary types.

Parameters:

session - the Session object, must not be null

selectPropertyIds - the property IDs in the SELECT statement, if null all properties are selected

fromTypes - a Map of type aliases (keys) and type IDs (values), the Map must contain exactly one primary type and zero or more secondary types

whereClause - an optional WHERE clause with placeholders ('?'), see QueryStatement for details

orderByPropertyIds - an optional list of properties IDs for the ORDER BY clause

Method Detail

setType

public void setType(int parameterIndex,
           String typeId)

Description copied from interface: QueryStatement

Sets the designated parameter to the query name of the given type ID.

Specified by:

setType in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

typeId - the type ID

setType

public void setType(int parameterIndex,
           ObjectType type)

Description copied from interface: QueryStatement

Sets the designated parameter to the query name of the given type.

Specified by:

setType in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

type - the object type

setProperty

public void setProperty(int parameterIndex,
               String typeId,
               String propertyId)

Description copied from interface: QueryStatement

Sets the designated parameter to the query name of the given property.

Specified by:

setProperty in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

propertyId - the property ID

setProperty

public void setProperty(int parameterIndex,
               PropertyDefinition<?> propertyDefinition)

Description copied from interface: QueryStatement

Sets the designated parameter to the query name of the given property.

Specified by:

setProperty in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

propertyDefinition - the property definition

setNumber

public void setNumber(int parameterIndex,
             Number... num)

Description copied from interface: QueryStatement

Sets the designated parameter to the given number.

Specified by:

setNumber in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

num - the number

setString

public void setString(int parameterIndex,
             String... str)

Description copied from interface: QueryStatement

Sets the designated parameter to the given string.

Specified by:

setString in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

str - the string

setStringContains

public void setStringContains(int parameterIndex,
                     String str)

Description copied from interface: QueryStatement

Sets the designated parameter to the given string in a CMIS contains statement.

Note that the CMIS specification requires two levels of escaping. The first level escapes ', ", \ characters to \', \" and \\. The characters *, ? and - are interpreted as text search operators and are not escaped on first level. If *, ?, - shall be used as literals, they must be passed escaped with \*, \? and \- to this method.

For all statements in a CONTAINS() clause it is required to isolate those from a query statement. Therefore a second level escaping is performed. On the second level grammar ", ', - and \ are escaped with a \. See the spec for further details.

Summary (input --> first level escaping --> second level escaping and output): * --> * --> * ? --> ? --> ? - --> - --> - \ --> \\ --> \\\\ (for any other character following other than * ? -) \* --> \* --> \\* \? --> \? --> \\? \- --> \- --> \\- ' --> \' --> \\\' " --> \" --> \\\"

Specified by:

setStringContains in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

str - the CONTAINS string

setStringLike

public void setStringLike(int parameterIndex,
                 String str)

Description copied from interface: QueryStatement

Sets the designated parameter to the given string. It does not escape backslashes ('\') in front of '%' and '_'.

Specified by:

setStringLike in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

str - the LIKE string

setId

public void setId(int parameterIndex,
         ObjectId... id)

Description copied from interface: QueryStatement

Sets the designated parameter to the given object ID.

Specified by:

setId in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

id - the object ID

setUri

public void setUri(int parameterIndex,
          URI... uri)

Description copied from interface: QueryStatement

Sets the designated parameter to the given URI.

Specified by:

setUri in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

uri - the URI

setUrl

public void setUrl(int parameterIndex,
          URL... url)

Description copied from interface: QueryStatement

Sets the designated parameter to the given URL.

Specified by:

setUrl in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

url - the URL

setBoolean

public void setBoolean(int parameterIndex,
              boolean... bool)

Description copied from interface: QueryStatement

Sets the designated parameter to the given boolean.

Specified by:

setBoolean in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

bool - the boolean

setDateTime

public void setDateTime(int parameterIndex,
               Calendar... cal)

Description copied from interface: QueryStatement

Sets the designated parameter to the given DateTime value.

Specified by:

setDateTime in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

cal - the DateTime value as Calendar object

setDateTimeTimestamp

public void setDateTimeTimestamp(int parameterIndex,
                        Calendar... cal)

Description copied from interface: QueryStatement

Sets the designated parameter to the given DateTime value with the prefix 'TIMESTAMP '.

Specified by:

setDateTimeTimestamp in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

cal - the DateTime value as Calendar object

setDateTime

protected void setDateTime(int parameterIndex,
               boolean prefix,
               Calendar... cal)

setDateTime

public void setDateTime(int parameterIndex,
               Date... date)

Description copied from interface: QueryStatement

Sets the designated parameter to the given DateTime value.

Specified by:

setDateTime in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

setDateTimeTimestamp

public void setDateTimeTimestamp(int parameterIndex,
                        Date... date)

Description copied from interface: QueryStatement

Sets the designated parameter to the given DateTime value with the prefix 'TIMESTAMP '.

Specified by:

setDateTimeTimestamp in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

setDateTime

protected void setDateTime(int parameterIndex,
               boolean prefix,
               Date... date)

setDateTime

public void setDateTime(int parameterIndex,
               long... ms)

Description copied from interface: QueryStatement

Sets the designated parameter to the given DateTime value.

Specified by:

setDateTime in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

setDateTimeTimestamp

public void setDateTimeTimestamp(int parameterIndex,
                        long... ms)

Description copied from interface: QueryStatement

Sets the designated parameter to the given DateTime value with the prefix 'TIMESTAMP '.

Specified by:

setDateTimeTimestamp in interface QueryStatement

Parameters:

parameterIndex - the parameter index (one-based)

setDateTime

protected void setDateTime(int parameterIndex,
               boolean prefix,
               long... ms)

toQueryString

public String toQueryString()

Description copied from interface: QueryStatement

Returns the query statement.

Specified by:

toQueryString in interface QueryStatement

Returns:

the query statement, not null

query

public ItemIterable<QueryResult> query(boolean searchAllVersions)

Description copied from interface: QueryStatement

Executes the query.

Specified by:

query in interface QueryStatement

Parameters:

searchAllVersions - true if all document versions should be included in the search results, false if only the latest document versions should be included in the search results

See Also:

Session.query(String, boolean)

query

public ItemIterable<QueryResult> query(boolean searchAllVersions,
                              OperationContext context)

Description copied from interface: QueryStatement

Executes the query.

Specified by:

query in interface QueryStatement

Parameters:

searchAllVersions - true if all document versions should be included in the search results, false if only the latest document versions should be included in the search results

context - the operation context to use

See Also:

Session.query(String, boolean, OperationContext)

clone

protected QueryStatementImpl clone()
                            throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

toString

public String toString()

Overrides:

toString in class Object