com.ontimize.gui.field

Class EntityFunctionAttribute

java.lang.Object

com.ontimize.gui.field.EntityFunctionAttribute

All Implemented Interfaces:

Serializable

public class EntityFunctionAttribute
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	attr String to identify the attribute
protected String	columName Name of the column to apply the function
protected String	entityName Name of the entity to make the query
protected String	function Function name (max, min, count(*), sum, avg ...)
protected Vector	parentkeys Column names to use as filter
protected Vector	queryColumns Column names to use in the select statement
protected boolean	useDefaultKeyFilter By default the query other entities in EntityTable class always make a filter with the entity key.
protected boolean	useNullValueToParentkeys Boolean to know if it is necessary use NullValues when parentkey columns have no value

Constructor Summary

Constructors

Constructor and Description
EntityFunctionAttribute(String attr, String entity, String column, Vector parentkeys, String functionName) Creates a new EntityFunctionAttribute instance

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAttr() Gets the identifier of the attribute
String	getColumn() Get the name of the columns to apply the function in
String	getEntityName() Gets the name of the entity
String	getFunction() Gets the function name
String	getFunctionStringQuery() Gets the string to use the function in the select statement with the necessary alias For example if function is max this returns "max(functionColumn) as attribute"
Vector	getParentkeys() Gets the name of the filter columns
Vector	getQueryColumns() Gets the column names to use in the query
int	hashCode()
boolean	isUseDefaultKeyFilter() Returns false if the query must not use the form key as filter.
boolean	isUseNullValueToParentkeys() Checks if the query must use NullValue objects when filter columns value is null
void	setAttr(String attr) Sets the identifier of the attribute
void	setCols(String column) Sets the column names to use in the select statement
void	setEntityName(String entityName) Sets the entity name
void	setFunction(String function) Sets the function name
void	setParentkeys(Vector filter) Sets the column to use as a filter in the select statement
void	setQueryColumns(Vector queryColumns) Sets the name of the columns to use in the query
void	setUseDefaultKeyFilter(boolean useDefaultKeyFilter) Sets the value of useDefaultKeyFilter parameter
void	setUseNullValueToParentkeys(boolean useNullValueToParentkeys) Sets the value of the useNullValueToParentkeys variable
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

attr

protected String attr

String to identify the attribute

entityName

protected String entityName

Name of the entity to make the query

columName

protected String columName

Name of the column to apply the function

parentkeys

protected Vector parentkeys

Column names to use as filter

function

protected String function

Function name (max, min, count(*), sum, avg ...)

queryColumns

protected Vector queryColumns

Column names to use in the select statement

useNullValueToParentkeys

protected boolean useNullValueToParentkeys

Boolean to know if it is necessary use NullValues when parentkey columns have no value

useDefaultKeyFilter

protected boolean useDefaultKeyFilter

By default the query other entities in EntityTable class always make a filter with the entity key.
If this parameter is false query not use the entity key as a filter parameter.

Constructor Detail

EntityFunctionAttribute

public EntityFunctionAttribute(String attr,
                       String entity,
                       String column,
                       Vector parentkeys,
                       String functionName)

Creates a new EntityFunctionAttribute instance

Parameters:

attr - Attribute identifier

entity - Entity name

column - Name of the column to apply the function in

filter - List of columns to use as filter in the query statement

functionName - Name of the function (avg, sum, max, min, count(*) ...)

Method Detail

getEntityName

public String getEntityName()

Gets the name of the entity

Returns:

setEntityName

public void setEntityName(String entityName)

Sets the entity name

Parameters:

entityName -

getColumn

public String getColumn()

Get the name of the columns to apply the function in

Returns:

setCols

public void setCols(String column)

Sets the column names to use in the select statement

Parameters:

column -

getParentkeys

public Vector getParentkeys()

Gets the name of the filter columns

Returns:

setParentkeys

public void setParentkeys(Vector filter)

Sets the column to use as a filter in the select statement

Parameters:

filter -

getAttr

public String getAttr()

Gets the identifier of the attribute

Returns:

setAttr

public void setAttr(String attr)

Sets the identifier of the attribute

Parameters:

attr -

isUseNullValueToParentkeys

public boolean isUseNullValueToParentkeys()

Checks if the query must use NullValue objects when filter columns value is null

Returns:

setUseNullValueToParentkeys

public void setUseNullValueToParentkeys(boolean useNullValueToParentkeys)

Sets the value of the useNullValueToParentkeys variable

Parameters:

useNullValueToParentkeys -

isUseDefaultKeyFilter

public boolean isUseDefaultKeyFilter()

Returns false if the query must not use the form key as filter. By default return true

Returns:

setUseDefaultKeyFilter

public void setUseDefaultKeyFilter(boolean useDefaultKeyFilter)

Sets the value of useDefaultKeyFilter parameter

Parameters:

useDefaultKeyFilter -

getFunction

public String getFunction()

Gets the function name

Returns:

setFunction

public void setFunction(String function)

Sets the function name

Parameters:

function -

getFunctionStringQuery

public String getFunctionStringQuery()

Gets the string to use the function in the select statement with the necessary alias
For example if function is max this returns "max(functionColumn) as attribute"

Returns:

getQueryColumns

public Vector getQueryColumns()

Gets the column names to use in the query

Returns:

setQueryColumns

public void setQueryColumns(Vector queryColumns)

Sets the name of the columns to use in the query

Parameters:

queryColumns -

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object