net.sf.farrago.fem.fennel
Interface FemWindowPartitionDefClass

All Superinterfaces:

RefBaseObject, RefClass, RefFeatured

All Known Implementing Classes:

FemWindowPartitionDefClass$Hib

public interface FemWindowPartitionDefClass
extends RefClass

WindowPartitionDef class proxy 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

FemWindowPartitionDef	createFemWindowPartitionDef() The default factory operation used to create an instance object.
FemWindowPartitionDef	createFemWindowPartitionDef(FemTupleProjection partitionKeyList, String initializeProgram, String addProgram, String dropProgram, FemTupleDescriptor bucketDesc) Creates an instance object having attributes initialized by the passed values.

Methods inherited from interface javax.jmi.reflect.RefClass

refAllOfClass, refAllOfType, refCreateInstance, refCreateStruct, refCreateStruct, refGetEnum, refGetEnum

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

createFemWindowPartitionDef

FemWindowPartitionDef createFemWindowPartitionDef()

The default factory operation used to create an instance object.

Returns:

The created instance object.

createFemWindowPartitionDef

FemWindowPartitionDef createFemWindowPartitionDef(FemTupleProjection partitionKeyList,
                                                  String initializeProgram,
                                                  String addProgram,
                                                  String dropProgram,
                                                  FemTupleDescriptor bucketDesc)

Creates an instance object having attributes initialized by the passed values.

Parameters:

partitionKeyList -

List of columns to partition the window on.

initializeProgram -

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

addProgram -

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

dropProgram -

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

bucketDesc -

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

Returns:

The created instance object.