com.mkdoc.query
Interface Query

All Superinterfaces:
QueryContext
All Known Implementing Classes:
SimpleQuery

public interface Query
extends QueryContext

A query that serves as a cache key.

Version:
0.5 2005-08-02
Author:
Philip Shaw

Field Summary
static java.lang.String VAR_SUMMARY
          The target summary variable name.
static java.lang.String VAR_TITLE
          The target title variable name.
static java.lang.String VAR_URI
          The target URI variable name.
 
Fields inherited from interface com.mkdoc.query.QueryContext
HTML, LIMIT, RSS, TEXT
 
Method Summary
 java.lang.String getQueryUri()
          Get a unique URI for the query.
 java.lang.String getQueryUri(int page)
          Get a request URI for a result set by page number.
 java.lang.String getResultKey()
          Get the unique result key for the query.
 java.lang.String getSeRQLQuery()
          Get an SeRQL query statement.
 
Methods inherited from interface com.mkdoc.query.QueryContext
getOutputType, getPageNumber, getResultsPerPage
 

Field Detail

VAR_URI

public static final java.lang.String VAR_URI
The target URI variable name.

Since:
Version 0.3 2005-07-28
See Also:
Constant Field Values

VAR_SUMMARY

public static final java.lang.String VAR_SUMMARY
The target summary variable name.

Since:
Version 0.3 2005-07-28
See Also:
Constant Field Values

VAR_TITLE

public static final java.lang.String VAR_TITLE
The target title variable name.

Since:
Version 0.3 2005-07-28
See Also:
Constant Field Values
Method Detail

getSeRQLQuery

public java.lang.String getSeRQLQuery()
Get an SeRQL query statement.

Returns:
An SeRQL query statement.
Since:
Version 0.1 2005-07-05

getQueryUri

public java.lang.String getQueryUri()
Get a unique URI for the query.

Returns:
A unique URI for the query.
Since:
Version 0.2 2005-07-26

getQueryUri

public java.lang.String getQueryUri(int page)
Get a request URI for a result set by page number.

Parameters:
page - The page for which to get a query URI.
Returns:
A unique URI for the query.
Since:
Version 0.5 2005-08-02

getResultKey

public java.lang.String getResultKey()
Get the unique result key for the query.

Returns:
A unique key for the query result in the form of a URI without output type or paging information.
Since:
Version 0.4 2005-08-01