Directive (Wandora

java.lang.Object
- org.wandora.query2.Directive

Direct Known Subclasses:

AllTopics, As, Average, BaseName, Concat, Count, Empty, Eval, FilterDirective, First, From, Identity, If, If.COND, Instances, Join, Last, Literals, Null, Occurrence, Of, Operand, OrderBy, Players, QueryEditorComponent.FinalResultDirective, Recursive, Roles, Static, SubjectIdentifiers, Sum, Topics, Types, Union, Unique, Variant, Variant2
```
public abstract class Directive
extends java.lang.Object
```
Subclasses must override at least one of query or queryIterator. Default implementation has them calling eachother. Whenever the result can meaningfully be delivered in smaller chunks, iterator should be used to avoid having huge array lists in memory.

Author:

olli

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String DEFAULT_COL

static java.lang.String DEFAULT_NS

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_COL`
`static java.lang.String`	`DEFAULT_NS`

Constructor Summary

Constructors
Constructor and Description

Directive()

Constructors
Constructor and Description
`Directive()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Directive`	`as(java.lang.String newRole)`
`Directive`	`as(java.lang.String original, java.lang.String newRole)`
`java.lang.String`	`debugString()`
`java.lang.String`	`debugString(java.lang.String indent)`
`static java.lang.String`	`debugStringInner(Directive[] directives, java.lang.String indent)`
`static java.lang.String`	`debugStringInner(Directive directive, java.lang.String indent)`
`static java.lang.String`	`debugStringInner(java.util.List<Directive> directives, java.lang.String indent)`
`java.lang.String`	`debugStringParams()`
`java.lang.String`	`debugStringParams(java.lang.String indent)`
`java.util.ArrayList<ResultRow>`	`doQuery(QueryContext context, ResultRow input)` This method does all necessary preparations, executes the query and returns with a list containing the results.
`void`	`endQuery(QueryContext context)` Signals end of query and performs any cleanup that may be needed.
`Directive`	`from(Directive d1)`
`Directive`	`from(Directive[] directives)`
`Directive`	`from(Directive d1, Directive d2)`
`Directive`	`from(Directive d1, Directive d2, Directive d3)`
`Directive`	`from(Directive d1, Directive d2, Directive d3, Directive d4)`
`Directive`	`from(java.lang.String s1)`
`Directive`	`from(java.lang.String[] literals)`
`Directive`	`from(java.lang.String s1, java.lang.String s2)`
`Directive`	`from(java.lang.String s1, java.lang.String s2, java.lang.String s3)`
`Directive`	`from(java.lang.String s1, java.lang.String s2, java.lang.String s3, java.lang.String s4)`
`static DirectiveUIHints.Addon[]`	`getStandardAddonHints()`
`static DirectiveUIHints.Addon[]`	`getStandardAddonHints(DirectiveUIHints.Addon[] extras)`
`boolean`	`isStatic()`
`Directive`	`join(Directive directive)`
`static void`	`main(java.lang.String[] args)`
`Directive`	`of(java.lang.String col)`
`java.util.ArrayList<ResultRow>`	`query(QueryContext context, ResultRow input)` Executes the query buffering all results in a list and returning that.
`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.
`Directive`	`to(Directive d1)`
`Directive`	`to(Directive[] directives)`
`Directive`	`to(Directive d1, Directive d2)`
`Directive`	`to(Directive d1, Directive d2, Directive d3)`
`Directive`	`to(Directive d1, Directive d2, Directive d3, Directive d4)`
`Directive`	`where(Directive d)`
`Directive`	`where(java.lang.Object c1, java.lang.String comp, java.lang.Object c2)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_NS

public static final java.lang.String DEFAULT_NS

See Also:: Constant Field Values

DEFAULT_COL

public static final java.lang.String DEFAULT_COL

See Also:: Constant Field Values

Constructor Detail
- Directive
```
public Directive()
```

Method Detail

getStandardAddonHints

public static DirectiveUIHints.Addon[] getStandardAddonHints()

getStandardAddonHints

public static DirectiveUIHints.Addon[] getStandardAddonHints(DirectiveUIHints.Addon[] extras)

startQuery
```
public boolean startQuery(QueryContext context)
                   throws QueryException
```
Prepares the query for execution. Extending classes must propagate the call to any contained queries.

Throws:

QueryException

endQuery
```
public void endQuery(QueryContext context)
              throws QueryException
```
Signals end of query and performs any cleanup that may be needed. Extending classes must propagate the call to any contained queries.

Throws:

QueryException

query
```
public java.util.ArrayList<ResultRow> query(QueryContext context,
                                            ResultRow input)
                                     throws QueryException
```
Executes the query buffering all results in a list and returning that. This may be useful at the top level where the results are going to be retrieved entirely in a list anyway. Inside the query you should avoid using this as the intermediate results can become very large due to join operations. startQuery must have been called before calling this and endQuery after the query is done. If this is the top level directive you may have to do it manually. These call should propaget automaticall to all inner queries.

Throws:

QueryException

doQuery
```
public java.util.ArrayList<ResultRow> doQuery(QueryContext context,
                                              ResultRow input)
                                       throws QueryException
```
This method does all necessary preparations, executes the query and returns with a list containing the results. This is the easiest way to execute a query. You can interrupt the query through the context object by calling interrupt in it.

Throws:

QueryException

queryIterator

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

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.

Throws:: QueryException

join

public Directive join(Directive directive)

to

public Directive to(Directive[] directives)

to
```
public Directive to(Directive d1)
```

to

public Directive to(Directive d1,
                    Directive d2)

to

public Directive to(Directive d1,
                    Directive d2,
                    Directive d3)

to

public Directive to(Directive d1,
                    Directive d2,
                    Directive d3,
                    Directive d4)

from

public Directive from(Directive[] directives)

from
```
public Directive from(Directive d1)
```

from

public Directive from(Directive d1,
                      Directive d2)

from

public Directive from(Directive d1,
                      Directive d2,
                      Directive d3)

from

public Directive from(Directive d1,
                      Directive d2,
                      Directive d3,
                      Directive d4)

from

public Directive from(java.lang.String[] literals)

from

public Directive from(java.lang.String s1)

from

public Directive from(java.lang.String s1,
                      java.lang.String s2)

from

public Directive from(java.lang.String s1,
                      java.lang.String s2,
                      java.lang.String s3)

from

public Directive from(java.lang.String s1,
                      java.lang.String s2,
                      java.lang.String s3,
                      java.lang.String s4)

of

public Directive of(java.lang.String col)

where

public Directive where(java.lang.Object c1,
                       java.lang.String comp,
                       java.lang.Object c2)

where
```
public Directive where(Directive d)
```

as

public Directive as(java.lang.String newRole)

as

public Directive as(java.lang.String original,
                    java.lang.String newRole)

isStatic
```
public boolean isStatic()
```

debugStringInner

public static java.lang.String debugStringInner(Directive[] directives,
                                                java.lang.String indent)

debugStringInner

public static java.lang.String debugStringInner(java.util.List<Directive> directives,
                                                java.lang.String indent)

debugStringInner

public static java.lang.String debugStringInner(Directive directive,
                                                java.lang.String indent)

debugStringParams

public java.lang.String debugStringParams()

debugStringParams

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

debugString
```
public java.lang.String debugString()
```

debugString

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

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:: java.lang.Exception

Class Directive

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_NS

DEFAULT_COL

Constructor Detail

Directive

Method Detail

getStandardAddonHints

getStandardAddonHints

startQuery

endQuery

query

doQuery

queryIterator

join

to

to

to

to

to

from

from

from

from

from

from

from

from

from

from

of

where

where

as

as

isStatic

debugStringInner

debugStringInner

debugStringInner

debugStringParams

debugStringParams

debugString

debugString

main