org.net2map.pov.server.DimensionField Class Reference

Inheritance diagram for org.net2map.pov.server.DimensionField:

[legend]Collaboration diagram for org.net2map.pov.server.DimensionField:

Detailed Description

DimensionField class represents a field of a query specified in a "select" clause.

Definition at line 26 of file DimensionField.java.

Public Member Functions

DimensionField (String name, String value)

Main constructor.

String getName ()

Return the field name.

String getValue ()

Return the field value.

boolean isKey ()

Test if field may is key or not.

boolean mustGroup ()

Test if the field is a agregate function (SUM,AVG,MAX,MIN,...).

void setName (String name)

Set the field name.

void setValue (String value)

Set the field value.

void setIsKey (boolean key)

Set if the field is key or not.

void setMustGroup (boolean group)

Set to specify the field as an agregate function (SUM,AVG,MAX,MIN,...).

Private Attributes

String sName

String sValue

boolean bIsKey

boolean bMustGroup

Constructor & Destructor Documentation

org.net2map.pov.server.DimensionField.DimensionField ( String name,

String value

)

Main constructor.

Parameters:

name Field name (may be an alias).

value Field value.

Definition at line 32 of file DimensionField.java.
References org.net2map.pov.server.DimensionField.bIsKey, org.net2map.pov.server.DimensionField.bMustGroup, org.net2map.pov.server.DimensionField.sName, and org.net2map.pov.server.DimensionField.sValue.

Member Function Documentation

String org.net2map.pov.server.DimensionField.getName ( )

Return the field name.

Returns:
Field name.

Definition at line 43 of file DimensionField.java.
References org.net2map.pov.server.DimensionField.sName.
Referenced by org.net2map.pov.server.Query.joinTo().

String org.net2map.pov.server.DimensionField.getValue ( )

Return the field value.

Returns:
Field value.

Definition at line 51 of file DimensionField.java.
References org.net2map.pov.server.DimensionField.sValue.
Referenced by org.net2map.pov.server.Query.joinTo().

boolean org.net2map.pov.server.DimensionField.isKey ( )

Test if field may is key or not.

Returns:
TRUE if key, else FALSE.

Definition at line 59 of file DimensionField.java.
References org.net2map.pov.server.DimensionField.bIsKey.
Referenced by org.net2map.pov.server.Query.joinTo().

boolean org.net2map.pov.server.DimensionField.mustGroup ( )

Test if the field is a agregate function (SUM,AVG,MAX,MIN,...).
If TRUE a "group by" clause have to be specified.
Returns:
TRUE if a "group by" clause must be specified due to this field, else FALSE.

Definition at line 68 of file DimensionField.java.
References org.net2map.pov.server.DimensionField.bMustGroup.
Referenced by org.net2map.pov.server.Query.joinTo().

void org.net2map.pov.server.DimensionField.setIsKey ( boolean key )

Set if the field is key or not.

Parameters:

key TRUE if key, else FALSE.

Definition at line 92 of file DimensionField.java.
References org.net2map.pov.server.DimensionField.bIsKey.
Referenced by org.net2map.pov.server.DimensionFieldList.addDimensionField().

void org.net2map.pov.server.DimensionField.setMustGroup ( boolean group )

Set to specify the field as an agregate function (SUM,AVG,MAX,MIN,...).

Parameters:

group TRUE if agregate function, else FALSE.

Definition at line 100 of file DimensionField.java.
References org.net2map.pov.server.DimensionField.bMustGroup.
Referenced by org.net2map.pov.server.DimensionFieldList.addDimensionField().

void org.net2map.pov.server.DimensionField.setName ( String name )

Set the field name.

Parameters:

name Field name.

Definition at line 76 of file DimensionField.java.
References org.net2map.pov.server.DimensionField.sName.

void org.net2map.pov.server.DimensionField.setValue ( String value )

Set the field value.

Parameters:

value Field value.

Definition at line 84 of file DimensionField.java.
References org.net2map.pov.server.DimensionField.sValue.

Member Data Documentation

boolean org.net2map.pov.server.DimensionField.bIsKey [private]

Definition at line 107 of file DimensionField.java.
Referenced by org.net2map.pov.server.DimensionField.DimensionField(), org.net2map.pov.server.DimensionField.isKey(), and org.net2map.pov.server.DimensionField.setIsKey().

boolean org.net2map.pov.server.DimensionField.bMustGroup [private]

Definition at line 108 of file DimensionField.java.
Referenced by org.net2map.pov.server.DimensionField.DimensionField(), org.net2map.pov.server.DimensionField.mustGroup(), and org.net2map.pov.server.DimensionField.setMustGroup().

String org.net2map.pov.server.DimensionField.sName [private]

Definition at line 105 of file DimensionField.java.
Referenced by org.net2map.pov.server.DimensionField.DimensionField(), org.net2map.pov.server.DimensionField.getName(), and org.net2map.pov.server.DimensionField.setName().

String org.net2map.pov.server.DimensionField.sValue [private]

Definition at line 106 of file DimensionField.java.
Referenced by org.net2map.pov.server.DimensionField.DimensionField(), org.net2map.pov.server.DimensionField.getValue(), and org.net2map.pov.server.DimensionField.setValue().

The documentation for this class was generated from the following file:

DimensionField.java