|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.softwareag.tamino.db.api.accessor.TQueryBuilder
public class TQueryBuilder
TQueryBuilder is a helper class that can be used for building TQuery instances for often used query expressions. This class implements the singleton pattern, i.e. there is always only one instance of this class available.
Nested Class Summary | |
---|---|
static class |
TQueryBuilder.TExplainLevel
Enum class for the explanation level constants used with the TQueryBuilder.explain() method. |
Constructor Summary | |
---|---|
protected |
TQueryBuilder()
Initializes the TQueryBuilder. |
Method Summary | |
---|---|
TQuery |
buildFromDocname(java.lang.String doctype,
java.lang.String docname)
Builds a TQuery instance for a query expression to retrieve a single document based on its ino:docname. |
TQuery |
buildFromId(java.lang.String doctype,
java.lang.String id)
Builds a TQuery instance for a query expression to retrieve a single document based on its ino:id. |
TQuery |
explain(java.lang.String query)
Builds a TQuery instance for a explain query with no explanation level. |
TQuery |
explain(java.lang.String query,
TQueryBuilder.TExplainLevel explainLevel)
Builds a TQuery instance for a explain query. |
static TQueryBuilder |
getInstance()
Gets the singleton instance of the TQueryBuilder. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected TQueryBuilder()
Method Detail |
---|
public static TQueryBuilder getInstance()
public TQuery buildFromId(java.lang.String doctype, java.lang.String id)
<doctype>[@ino:id="<id>"] <\pre>
doctype
- the doctype of the document to be retrieved.id
- the ino:id of the document to be retrieved.
public TQuery buildFromDocname(java.lang.String doctype, java.lang.String docname)
<doctype>[@ino:docname="<docname>"] <\pre>
doctype
- the doctype of the document to be retrieved.docname
- the ino:docname of the document to be retrieved.
public TQuery explain(java.lang.String query)
query
- the query to explain.
public TQuery explain(java.lang.String query, TQueryBuilder.TExplainLevel explainLevel)
query
- the query to explain.explainLevel
- the level of explanation.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |