net.sf.farrago.fem.fennel
Interface FemWindowDef

All Superinterfaces:
RefBaseObject, RefFeatured, RefObject
All Known Implementing Classes:
FemWindowDef$Hib

public interface FemWindowDef
extends RefObject

WindowDef object instance interface.

The definition of a window inside a FemWindowStreamDef.

A window has either a logical or physical range, and contains a number of partitions:

Note: This type should not be subclassed, implemented or directly instantiated by clients. It is generated from a MOF metamodel and implemented by Enki or MDR.


Method Summary
 int getOffset()
          Returns the value of attribute offset.
 FemTupleProjection getOrderKeyList()
          Returns the value of attribute orderKeyList.
 List<FemWindowPartitionDef> getPartition()
          Returns the value of reference Partition.
 String getRange()
          Returns the value of attribute range.
 FemWindowStreamDef getWindowStream()
          Returns the value of reference WindowStream.
 boolean isPhysical()
          Returns the value of attribute physical.
 void setOffset(int newValue)
          Sets the value of offset attribute.
 void setOrderKeyList(FemTupleProjection newValue)
          Sets the value of orderKeyList attribute.
 void setPhysical(boolean newValue)
          Sets the value of physical attribute.
 void setRange(String newValue)
          Sets the value of range attribute.
 void setWindowStream(FemWindowStreamDef newValue)
          Sets the value of WindowStream reference.
 
Methods inherited from interface javax.jmi.reflect.RefObject
refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite
 
Methods inherited from interface javax.jmi.reflect.RefFeatured
refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue
 
Methods inherited from interface javax.jmi.reflect.RefBaseObject
equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints
 

Method Detail

getOrderKeyList

FemTupleProjection getOrderKeyList()
Returns the value of attribute orderKeyList.

List of columns to sort the window on. For example, in WINDOW w AS (ORDER BY hiredate PARTITION BY gender ROWS 5 PRECEDING), the order list is "hiredate".

Often the optimizer will have ensured that the input stream is already sorted on the sort key, or at least a subset of it; for infinite relations, this is required in order to perform aggregation. See FemWindowStreamDef.getInputOrderKeyList().

Returns:
Value of attribute orderKeyList.

setOrderKeyList

void setOrderKeyList(FemTupleProjection newValue)
Sets the value of orderKeyList attribute. See getOrderKeyList() for description on the attribute.

Parameters:
newValue - New value to be set.

isPhysical

boolean isPhysical()
Returns the value of attribute physical.

True if the window is physical (defined by a number of rows); false if the window is logical (defined by a range of values).

Returns:
Value of attribute physical.

setPhysical

void setPhysical(boolean newValue)
Sets the value of physical attribute. See isPhysical() for description on the attribute.

Parameters:
newValue - New value to be set.

getRange

String getRange()
Returns the value of attribute range.

If physical, the number of rows; if logical, the value range (for example, 3,600,000 milliseconds).

Returns:
Value of attribute range.

setRange

void setRange(String newValue)
Sets the value of range attribute. See getRange() for description on the attribute.

Parameters:
newValue - New value to be set.

getOffset

int getOffset()
Returns the value of attribute offset.

This is the offset of the window. Positive value refers to a leading window and negative value refers to a trailing window.

Returns:
Value of attribute offset.

setOffset

void setOffset(int newValue)
Sets the value of offset attribute. See getOffset() for description on the attribute.

Parameters:
newValue - New value to be set.

getPartition

List<FemWindowPartitionDef> getPartition()
Returns the value of reference Partition.

Returns:
Value of reference Partition. Element type: FemWindowPartitionDef

getWindowStream

FemWindowStreamDef getWindowStream()
Returns the value of reference WindowStream.

Returns:
Value of reference WindowStream.

setWindowStream

void setWindowStream(FemWindowStreamDef newValue)
Sets the value of WindowStream reference. See getWindowStream() for description on the attribute.

Parameters:
newValue - New value to be set.