com.sapportals.wcm.repository.search

Interface IGenericQueryFactory

public interface IGenericQueryFactory

Builds generic query expressions.

Copyright (c) SAP AG 2002

Method Summary

IQueryExpression	fromXml(String persistedQuery) Transforms a persisted query (obtained from fromXml(String) back into a generic query expression.
IQueryBuilder	getQueryBuilder() Retrieve a generic query builder, which builds IQueryExpressions.
IGenericQuery	toGenericQuery(IQueryExpression query) Convert the given query to a generic one.
String	toXml(IQueryExpression queryExpression) Transforms a generic query expression into a plain string that can be persisted.

Method Detail

getQueryBuilder

public IQueryBuilder getQueryBuilder()

Retrieve a generic query builder, which builds IQueryExpressions.

Returns:

IQueryBuilder for constructing query

toGenericQuery

public IGenericQuery toGenericQuery(IQueryExpression query)
                             throws NotSupportedException

Convert the given query to a generic one. The query must have been build with a query builder retrieved through this object. Further modifications of the query will not alter the generated IGenericQuery.

Parameters:

query - to convert to a generic one

Returns:

generic query

Throws:

NotSupportedException - if query was not created through correct builder

fromXml

public IQueryExpression fromXml(String persistedQuery)
                         throws ResourceException

Transforms a persisted query (obtained from fromXml(String) back into a generic query expression.

Parameters:

persistedQuery - persisted query string

Returns:

generic query expression

Throws:

ResourceException - if the string could not be transformed into a valid generic query expression

toXml

public String toXml(IQueryExpression queryExpression)
             throws ResourceException

Transforms a generic query expression into a plain string that can be persisted.

Parameters:

queryExpression - query expression

Returns:

query expression as string that can be fed back into fromXml(String)

Throws:

ResourceException - when the query expression could not be persisted (for instance, when it wasn't obtained from getQueryBuilder().