edu.wpi.cs.dsrg.xmldb.xat.common.operator
Interface XATOperator

All Known Subinterfaces:
Aggregate, All, CartesianProduct, Composer, Delete, Difference, Distinct, Expose, FOR, Function, GroupBy, IfExpr, Insert, Intersection, Join, LeftOuterJoin, LeftSemiJoin, Merge, NameColumn, NavCollection, Navigate, NavUnnest, Or, OrderBy, OuterUnion, Project, Rename, Replace, RightOuterJoin, RightSemiJoin, Select, Source, SpecialOperator, SQLOperator, SQLStmt, Tagger, ThetaJoin, Union, UpdateOperator, XATMultiSourceOperator, XMLDifference, XMLIntersection, XMLOperator, XMLUnion, XQueryStmt
All Known Implementing Classes:
XATOperatorImp

public interface XATOperator
extends XATQueryObject, java.lang.Cloneable

Super class for all the XAT operators.

Since:
1.0

Method Summary
 java.lang.Object clone()
          Clones the XATOperator.
 XATNode getNode()
          Gets the node of this operator in order to get children or parent nodes.
 XATTable getOutput()
          Deprecated. use XATOperator.getOutputDataSource, then cast to a table or a queue
 java.lang.String getOutputColumnName()
          Gets output column name.
 XATDataSource getOutputDataSource()
          Get the output of this Operator.
 java.util.Iterator getOutputDataSources()
          Get all output data sources for this XATOperator
 XATDataSource getPrimaryDataSource()
          Get primary data source.
 XATTable getPrimarySource()
          Deprecated. use XATOperator.getPrimaryDataSource, then cast to a table or a queue
 void setNode(XATNode newNode)
          Sets the opertor's node.
 void setOutput(XATDataSource newoutput)
          Sets the ouput data source.
 void setOutputColumnName(java.lang.String OutputColumnName)
          Sets output columns.
 
Methods inherited from interface edu.wpi.cs.dsrg.xmldb.xat.common.operator.XATQueryObject
getStatistics, isValidStatistic
 
Methods inherited from interface edu.wpi.cs.dsrg.xmldb.xat.common.operator.XATProperties
getProperties, getProperty, isValidPropertyName, setProperty
 

Method Detail

clone

public java.lang.Object clone()
Clones the XATOperator.
Overrides:
clone in class java.lang.Object
Since:
1.0

getNode

public XATNode getNode()
Gets the node of this operator in order to get children or parent nodes.
Returns:
XATNode
Since:
1.0

getOutput

public XATTable getOutput()
Deprecated. use XATOperator.getOutputDataSource, then cast to a table or a queue

Gets the output of this Operator.
Returns:
the output XATTable of this operator.
Since:
1.0

getOutputColumnName

public java.lang.String getOutputColumnName()
Gets output column name.
Returns:
output column name
Since:
1.0

getOutputDataSource

public XATDataSource getOutputDataSource()
Get the output of this Operator.
Returns:
the output DataSource of this operator.
Since:
1.0

getOutputDataSources

public java.util.Iterator getOutputDataSources()
Get all output data sources for this XATOperator
Returns:
Iterator of data sources.
Since:
1.0

getPrimaryDataSource

public XATDataSource getPrimaryDataSource()
                                   throws XATNodeDoesNotExistException
Get primary data source. The primary data source will be the first data source in all the operators. For example: For all the Join the primary data source is source l. For all the Union operators is the first source. For CO is the source S1.
Returns:
XATDataSource of the primary data source.
Throws:
XATNodeDoesNotExistException -  
Since:
1.0

getPrimarySource

public XATTable getPrimarySource()
                          throws XATNodeDoesNotExistException
Deprecated. use XATOperator.getPrimaryDataSource, then cast to a table or a queue

Get primary data source. The primary data source will be the first data source in all the operators. For example: For all the Join the primary data source is source l. For all the Union operators is the first source. For CO is the source S1.
Returns:
XATTable of the primary data source.
Throws:
XATNodeDoesNotExistException -  
Since:
1.0

setNode

public void setNode(XATNode newNode)
Sets the opertor's node.
Parameters:
newNode - edu.wpi.cs.dsrg.xmldb.xat.common.xatnode.XATNode
Since:
1.0

setOutput

public void setOutput(XATDataSource newoutput)
Sets the ouput data source.
Parameters:
newoutput - output data source

setOutputColumnName

public void setOutputColumnName(java.lang.String OutputColumnName)
Sets output columns.
Parameters:
OutputColumnName - java.lang.String
Since:
1.0