ComputedField Class Reference

Provides access to a computed field which is referenced by a DataSource. More...

List of all members.

Public Member Functions

void dispose () throws TFormerException
 Releases the resources allocated into TFORMer runtime by this instance.
void dump (PrintStream s) throws IOException, TFormerException
 Dumps the current instance into a text stream.
Aggregation getAggregation () throws TFormerException
 Gets the type of aggregation of the ComputedField.
String getComment () throws TFormerException
 Gets the comment of the ComputedField.
String getExpression () throws TFormerException
 Gets the expression of the ComputedField.
String getFilter () throws TFormerException
 Gets the filter of the ComputedField.
String getName () throws TFormerException
 Gets the name of the ComputedField.
ComputedField getNext () throws TFormerException
 Gets the next instance defined in the DataSource.
long getOrder () throws TFormerException
 Gets the order of the ComputedField.
void setAggregation (Aggregation aggregation) throws TFormerException
 Sets the type of aggregation of the ComputedField.
void setComment (String sComment) throws TFormerException
 Sets the comment of the ComputedField.
void setExpression (String sExpression) throws TFormerException
 Sets the expression of the ComputedField.
void setFilter (String sFilter) throws TFormerException
 Sets the filter of the ComputedField.
void setName (String sName) throws TFormerException
 Sets the name of the ComputedField.
void setOrder (long lOrder) throws TFormerException
 Sets the order of the ComputedField.
String toString ()
 Returns a string representation of the instance.


Detailed Description

Provides access to a computed field which is referenced by a DataSource.





A computed field adds an additional column to a DataSource. The content of this column is either specified as a constant value or it is computed using an arbitrary Expression. In the expression you may refer to other sourcefields and computed fields as basis for calculation.


The usual purpose of a computed field is to compute values which are based on sourcefields or other ComputedFields. For examples, you might convert the content of an existing sourcefield to uppercase, or remove leading and trailing spaces. You can also concatenate multiple sourcefields into a single sourcefield. Or you can perform numerical computations (e.g. add the VAT (Value Added Tax)).


In addition, ComputedFields support Aggregation(see getAggregation or setAggregation) functions. Thus it is pretty simple to create serial numbers or to calculate running sums and averages which are not available in a DataSource directly.


Member Function Documentation

void dispose (  )  throws TFormerException

Releases the resources allocated into TFORMer runtime by this instance.

Remember to call this method always after the use of the instance, in order to release the memory allocated.

Exceptions:
TFormerException error occurred into TFORMer runtime.

void dump ( PrintStream  s  )  throws IOException, TFormerException

Dumps the current instance into a text stream.

Parameters:
s instance of the stream
Exceptions:
IOException error in I/O
TFormerException error occurred into TFORMer runtime.

Aggregation getAggregation (  )  throws TFormerException

Gets the type of aggregation of the ComputedField.

Returns:
The type of aggregation of the ComputedField.
Exceptions:
TFormerException error occurred into TFORMer runtime.

String getComment (  )  throws TFormerException

Gets the comment of the ComputedField.

Returns:
The comment of the ComputedField.
Exceptions:
TFormerException error occurred into TFORMer runtime.

String getExpression (  )  throws TFormerException

Gets the expression of the ComputedField.

Returns:
The expression of the ComputedField.
Exceptions:
TFormerException error occurred into TFORMer runtime.

String getFilter (  )  throws TFormerException

Gets the filter of the ComputedField.

Returns:
The filter of the ComputedField.
Exceptions:
TFormerException error occurred into TFORMer runtime.

String getName (  )  throws TFormerException

Gets the name of the ComputedField.

Returns:
The name of the ComputedField.
Exceptions:
TFormerException error occurred into TFORMer runtime.

ComputedField getNext (  )  throws TFormerException

Gets the next instance defined in the DataSource.

A DataSource stores a list of ComputedField objects. You can use this method to iterate through the list. To retrieve the first ComputedField in the DataSource see DataSource.getFirstComputedField().

Returns:
null if there aren't other instances into the project, otherwise a valid instance
Exceptions:
TFormerException error occurred into TFORMer runtime.

long getOrder (  )  throws TFormerException

Gets the order of the ComputedField.

Returns:
The order of the ComputedField.
Exceptions:
TFormerException error occurred into TFORMer runtime.

void setAggregation ( Aggregation  aggregation  )  throws TFormerException

Sets the type of aggregation of the ComputedField.

Parameters:
aggregation The type of aggregation of the ComputedField.
Exceptions:
TFormerException error occurred into TFORMer runtime.

void setComment ( String  sComment  )  throws TFormerException

Sets the comment of the ComputedField.

Parameters:
sComment The comment of the ComputedField.
Exceptions:
TFormerException error occurred into TFORMer runtime.

void setExpression ( String  sExpression  )  throws TFormerException

Sets the expression of the ComputedField.

Parameters:
sExpression The expression of the ComputedField.
Exceptions:
TFormerException error occurred into TFORMer runtime.

void setFilter ( String  sFilter  )  throws TFormerException

Sets the filter of the ComputedField.

Parameters:
sFilter The filter of the ComputedField.
Exceptions:
TFormerException error occurred into TFORMer runtime.

void setName ( String  sName  )  throws TFormerException

Sets the name of the ComputedField.

Parameters:
sName The name of the ComputedField.
Exceptions:
TFormerException error occurred into TFORMer runtime.

void setOrder ( long  lOrder  )  throws TFormerException

Sets the order of the ComputedField.

Parameters:
lOrder The order of the ComputedField.
Exceptions:
TFormerException error occurred into TFORMer runtime.

String toString (  ) 

Returns a string representation of the instance.

Returns:
a string representation of the instance


© 2006-2009 All rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Wed Sep 2 16:01:27 2009 for TFORMer Runtime JAVA Developer Reference with doxygen 1.5.8