org.squashtest.tm.domain.chart

Class ColumnPrototype

java.lang.Object

org.squashtest.tm.domain.chart.ColumnPrototype

@Entity
public class ColumnPrototype
extends Object

Represents the concept of "attribute of an entity" :

• it is pretty much like a column in a relational model (the "Column" part)
• it is a referential data that will "instanciated" in a ChartDefinition (the "Prototype" part)

Taxonomy : ColumnPrototypes comes in three varieties :

• Attribute columns : these columns refer to a proper attribute of the ENTITY_TYPE.
• Calculated columns : these columns don't physically exist and must be calculated.
• Customfield columns : these columns represent custom fields of this entity (detached and configurable attributes)

Usage : A ColumnPrototype may be specialized to assume on of the three ColumnRoles : it can be filtered on, or it can hold the observable value displayed in the chart, or be an axis of this chart. See Filter, AxisColumn, MeasureColumn

No user shall create them: only the system can do that. Typically prototypes will be inserted or removed when custom fields are bound to/ unbound from entities.

Author:

bsiri

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ColumnPrototype()
	ColumnPrototype(String label, SpecializedEntityType specializedType, DataType dataType, ColumnType columnType, ChartQuery subQuery, String attributeName, boolean business, Set<ColumnRole> role)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAttributeName()
ColumnType	getColumnType()
DataType	getDataType()
SpecializedEntityType.EntityRole	getEntityRole()
EntityType	getEntityType()
Long	getId()
String	getLabel()
EnumSet<ColumnRole>	getRole()
SpecializedEntityType	getSpecializedType()
ChartQuery	getSubQuery() May be null : ColumnPrototypes having ColumnType.ATTRIBUTE have no subqueries for instance.
boolean	isBusiness()
void	setAttributeName(String attributeName)
void	setLabel(String label)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ColumnPrototype

protected ColumnPrototype()

ColumnPrototype

public ColumnPrototype(String label,
               SpecializedEntityType specializedType,
               DataType dataType,
               ColumnType columnType,
               ChartQuery subQuery,
               String attributeName,
               boolean business,
               Set<ColumnRole> role)

Method Detail

getId

public Long getId()

getColumnType

public ColumnType getColumnType()

getAttributeName

public String getAttributeName()

getLabel

public String getLabel()

getEntityType

public EntityType getEntityType()

getSpecializedType

public SpecializedEntityType getSpecializedType()

getEntityRole

public SpecializedEntityType.EntityRole getEntityRole()

getDataType

public DataType getDataType()

getRole

public EnumSet<ColumnRole> getRole()

getSubQuery

public ChartQuery getSubQuery()

May be null : ColumnPrototypes having ColumnType.ATTRIBUTE have no subqueries for instance.

Returns:

isBusiness

public boolean isBusiness()

setLabel

public void setLabel(String label)

setAttributeName

public void setAttributeName(String attributeName)