net.sf.farrago.fem.fennel
Interface FemWindowPartitionDef

All Superinterfaces:

RefBaseObject, RefFeatured, RefObject

All Known Implementing Classes:

FemWindowPartitionDef$Hib

public interface FemWindowPartitionDef
extends RefObject

WindowPartitionDef object instance interface.

A set of rows within a window which have a common value for a partitioning key. Each row is referred to as a 'bucket'.

There are actions -- expressed as calculator programs -- which get executed when a new bucket is created, when a set of values are added to a bucket, and when a set of values are removed from a bucket.

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

String	getAddProgram() Returns the value of attribute addProgram.
FemTupleDescriptor	getBucketDesc() Returns the value of attribute bucketDesc.
String	getDropProgram() Returns the value of attribute dropProgram.
String	getInitializeProgram() Returns the value of attribute initializeProgram.
FemTupleProjection	getPartitionKeyList() Returns the value of attribute partitionKeyList.
FemWindowDef	getWindow() Returns the value of reference Window.
void	setAddProgram(String newValue) Sets the value of addProgram attribute.
void	setBucketDesc(FemTupleDescriptor newValue) Sets the value of bucketDesc attribute.
void	setDropProgram(String newValue) Sets the value of dropProgram attribute.
void	setInitializeProgram(String newValue) Sets the value of initializeProgram attribute.
void	setPartitionKeyList(FemTupleProjection newValue) Sets the value of partitionKeyList attribute.
void	setWindow(FemWindowDef newValue) Sets the value of Window 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

getPartitionKeyList

FemTupleProjection getPartitionKeyList()

Returns the value of attribute partitionKeyList.

List of columns to partition the window on.

Returns:

Value of attribute partitionKeyList.

setPartitionKeyList

void setPartitionKeyList(FemTupleProjection newValue)

Sets the value of partitionKeyList attribute. See getPartitionKeyList() for description on the attribute.

Parameters:

newValue - New value to be set.

getInitializeProgram

String getInitializeProgram()

Returns the value of attribute initializeProgram.

Calculator program executed to initialize a bucket of this window. Typically simply zeroes out the values.

Returns:

Value of attribute initializeProgram.

setInitializeProgram

void setInitializeProgram(String newValue)

Sets the value of initializeProgram attribute. See getInitializeProgram() for description on the attribute.

Parameters:

newValue - New value to be set.

getAddProgram

String getAddProgram()

Returns the value of attribute addProgram.

Calculator program executed to add a value to each field of a bucket of this window.

Returns:

Value of attribute addProgram.

setAddProgram

void setAddProgram(String newValue)

Sets the value of addProgram attribute. See getAddProgram() for description on the attribute.

Parameters:

newValue - New value to be set.

getDropProgram

String getDropProgram()

Returns the value of attribute dropProgram.

Calculator program executed to remove a value from each field of a bucket of this window.

Returns:

Value of attribute dropProgram.

setDropProgram

void setDropProgram(String newValue)

Sets the value of dropProgram attribute. See getDropProgram() for description on the attribute.

Parameters:

newValue - New value to be set.

getBucketDesc

FemTupleDescriptor getBucketDesc()

Returns the value of attribute bucketDesc.

Describes the types of the columns in a bucket belonging to this window.

Returns:

Value of attribute bucketDesc.

setBucketDesc

void setBucketDesc(FemTupleDescriptor newValue)

Sets the value of bucketDesc attribute. See getBucketDesc() for description on the attribute.

Parameters:

newValue - New value to be set.

getWindow

FemWindowDef getWindow()

Returns the value of reference Window.

Returns:

Value of reference Window.

setWindow

void setWindow(FemWindowDef newValue)

Sets the value of Window reference. See getWindow() for description on the attribute.

Parameters:

newValue - New value to be set.