org.wandora.query2

Class First

java.lang.Object

org.wandora.query2.Directive

org.wandora.query2.First

All Implemented Interfaces:

DirectiveUIHints.Provider

public class First
extends Directive
implements DirectiveUIHints.Provider

Author:

olli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	First.FirstIterator

Field Summary

Fields

Modifier and Type	Field and Description
private int	count
private Directive	directive

Fields inherited from class org.wandora.query2.Directive

DEFAULT_COL, DEFAULT_NS

Constructor Summary

Constructors

Constructor and Description
First()
First(Directive directive)
First(int count, Directive directive)

Method Summary

Modifier and Type	Method and Description
java.lang.String	debugStringParams(java.lang.String indent)
void	endQuery(QueryContext context) Signals end of query and performs any cleanup that may be needed.
DirectiveUIHints	getUIHints()
ResultIterator	queryIterator(QueryContext context, ResultRow input) You must call startQuery before calling this and endQuery after you are done with the result iterator.
boolean	startQuery(QueryContext context) Prepares the query for execution.

Methods inherited from class org.wandora.query2.Directive

as, as, debugString, debugString, debugStringInner, debugStringInner, debugStringInner, debugStringParams, doQuery, from, from, from, from, from, from, from, from, from, from, getStandardAddonHints, getStandardAddonHints, isStatic, join, main, of, query, to, to, to, to, to, where, where

Methods inherited from class java.lang.Object

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

Field Detail

directive

private Directive directive

count

private int count

Constructor Detail

First

public First()

First

public First(int count,
             Directive directive)

First

public First(Directive directive)

Method Detail

getUIHints

public DirectiveUIHints getUIHints()

Specified by:

getUIHints in interface DirectiveUIHints.Provider

startQuery

public boolean startQuery(QueryContext context)
                   throws QueryException

Description copied from class: Directive

Prepares the query for execution. Extending classes must propagate the call to any contained queries.

Overrides:

startQuery in class Directive

Throws:

QueryException

endQuery

public void endQuery(QueryContext context)
              throws QueryException

Description copied from class: Directive

Signals end of query and performs any cleanup that may be needed. Extending classes must propagate the call to any contained queries.

Overrides:

endQuery in class Directive

Throws:

QueryException

queryIterator

public ResultIterator queryIterator(QueryContext context,
                                    ResultRow input)
                             throws QueryException

Description copied from class: Directive

You must call startQuery before calling this and endQuery after you are done with the result iterator. You should also call dispose of the result iterator when you're done.

Overrides:

queryIterator in class Directive

Throws:

QueryException

debugStringParams

public java.lang.String debugStringParams(java.lang.String indent)

Overrides:

debugStringParams in class Directive