org.objectweb.medor.query.lib
Class BasicQueryTree

java.lang.Object
  extended byBasicCloneable
      extended byorg.objectweb.medor.lib.BasicTupleStructure
          extended byorg.objectweb.medor.query.lib.BasicQueryTree
All Implemented Interfaces:
AnnotationsHolder, java.lang.Cloneable, Cloneable, QueryTree, java.io.Serializable, TupleStructure
Direct Known Subclasses:
BasicQueryNode, BasicRdbQueryLeaf

public abstract class BasicQueryTree
extends BasicTupleStructure
implements QueryTree

A BasicQueryNode is an implementation of QueryNode. It also implements QueryIndexGenerator and RWTupleStructure (it is its own TupleStructure).

Author:
Sebastien Chassande-Barrioz
See Also:
Serialized Form

Field Summary
protected  java.util.Map annotations
           
protected  boolean distinct
           
protected  int[] indexes
          Contains ranges of attribute to be projected from the tuple resulting of the concatenation of the tuples from the children QueryTrees.
protected  java.lang.String name
           
protected  OrderField[] orderfields
           
 
Fields inherited from class org.objectweb.medor.lib.BasicTupleStructure
fields, logger, name2field
 
Constructor Summary
BasicQueryTree()
           
BasicQueryTree(java.lang.String _name)
           
 
Method Summary
 java.lang.Object clone(java.lang.Object clone, java.util.Map obj2clone)
           
 java.util.Map getAnnotations()
           
 boolean getDistinct()
          Tests whether the results should be distinct or not.
 java.lang.String getName()
          It returns the name of the query tree.
 OrderField[] getOrderBy()
          Returns the array of OrderFields indicating how the result should be ordered.
 TupleStructure getTupleStructure()
          Returns the TupleStructure associated to the QueryTree.
 void setDistinct(boolean distinct)
          Indicates whether evaluating the QueryTree should return unique results (duplicate elimination) or not.
 void setOrderBy(OrderField[] orderfields)
          Sets the OrderBy array of OrderFields.
 
Methods inherited from class org.objectweb.medor.lib.BasicTupleStructure
contains, contains, getField, getField, getFieldRank, getFields, getSize
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.objectweb.medor.api.Cloneable
clone
 

Field Detail

name

protected java.lang.String name

indexes

protected int[] indexes
Contains ranges of attribute to be projected from the tuple resulting of the concatenation of the tuples from the children QueryTrees.


distinct

protected boolean distinct

orderfields

protected OrderField[] orderfields

annotations

protected java.util.Map annotations
Constructor Detail

BasicQueryTree

public BasicQueryTree()

BasicQueryTree

public BasicQueryTree(java.lang.String _name)
Method Detail

clone

public java.lang.Object clone(java.lang.Object clone,
                              java.util.Map obj2clone)
                       throws java.lang.CloneNotSupportedException
Overrides:
clone in class BasicTupleStructure
Throws:
java.lang.CloneNotSupportedException

getName

public java.lang.String getName()
Description copied from interface: QueryTree
It returns the name of the query tree.

Specified by:
getName in interface QueryTree

getTupleStructure

public TupleStructure getTupleStructure()
Description copied from interface: QueryTree
Returns the TupleStructure associated to the QueryTree. Note that the Fields cannot be added by manipulating the TupleStructure, but by using either constructors in the case of a QueryLeaf, or by using the addXXXFields methods in the case of QueryNodes.

Specified by:
getTupleStructure in interface QueryTree

setDistinct

public void setDistinct(boolean distinct)
                 throws MedorException
Description copied from interface: QueryTree
Indicates whether evaluating the QueryTree should return unique results (duplicate elimination) or not.

The default should be that duplicates are not eliminated (distinct is false).

Specified by:
setDistinct in interface QueryTree
Parameters:
distinct - is true if duplicates should be eliminated, false otherwise.
Throws:
MedorException - if the distinct operation is not supported.

getDistinct

public boolean getDistinct()
Description copied from interface: QueryTree
Tests whether the results should be distinct or not.

Specified by:
getDistinct in interface QueryTree
Returns:
true if there results should be distinct, false otherwise.

setOrderBy

public void setOrderBy(OrderField[] orderfields)
Description copied from interface: QueryTree
Sets the OrderBy array of OrderFields.

This array indicates the fields by which the results should be ordered.

Like for filters assigned to QueryNodes, the Fields used for ordering must belong to children of the current QueryTree.

A noticeable exception is the case of RdbExpQueryLeaves, where ordering fields are fields of the QueryLeaf itself.

Specified by:
setOrderBy in interface QueryTree
Parameters:
orderfields - the array of OrderFields indicating the ordering in which the result should be returned.

getOrderBy

public OrderField[] getOrderBy()
Description copied from interface: QueryTree
Returns the array of OrderFields indicating how the result should be ordered.

Specified by:
getOrderBy in interface QueryTree
Returns:
the array of OrderFields.

getAnnotations

public java.util.Map getAnnotations()
Specified by:
getAnnotations in interface AnnotationsHolder
Returns:
a map containing associations key <-> value defining the annotations.