net.sf.basedb.core.data
Class ExtraValueTypeData

java.lang.Object
  net.sf.basedb.core.data.BasicData
      net.sf.basedb.core.data.ExtraValueTypeData

All Implemented Interfaces:

IdentifiableData, NameableData, RegisteredData, RemovableData

public class ExtraValueTypeData
extends BasicData
implements NameableData, RemovableData, RegisteredData

This represents the definitiona of an extra value type that can be calculated by a plugin.

Version:

2.0

Author:

Nicklas

See Also:

ExtraValueType, Developer documentation: Experiments and analysis

Last modified

$Date: 2011-10-21 13:15:41 +0200 (Fri, 21 Oct 2011) $

Hibernate: class

table="`ExtraValueTypes`" lazy="true"

Field Summary

private int	averageMethod
private ColoringData	coloring
private String	description
private Date	entryDate
private String	externalId
private Set<ExtraValueData>	extraValues
static int	MAX_EXTERNAL_ID_LENGTH The maximum length of the external id that can be stored in the database.
private String	name
private boolean	removed
private int	valueType

Fields inherited from interface net.sf.basedb.core.data.NameableData

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

ExtraValueTypeData()

Method Summary

int	getAverageMethod() The average method for thid formula: 0 = none, Formula.AverageMethod.NONE; no average is defined for this formula 1 = geometric mean, Formula.AverageMethod.GEOMETRIC_MEAN; this formula uses geometric mean 2 = arithmetic mean, Formula.AverageMethod.ARITHMETIC_MEAN; this formula uses arithmetic mean 3 = min, Formula.AverageMethod.MIN; this formula uses the min value as a "mean" 4 = max, Formula.AverageMethod.MAX; this formula uses the max value as a "mean"
ColoringData	getColoring() Get the coloring information for this extra value type.
String	getDescription() Get the description for the item.
Date	getEntryDate() Get the date this item was added to the database.
String	getExternalId() Get the external id for this ExtraValueType item.
(package private) Set<ExtraValueData>	getExtraValues() This is the inverse end.
String	getName() Get the name of the item.
int	getValueType() The code for the value type.
boolean	isRemoved() Check if the removed flag is set for this item.
void	setAverageMethod(int averageMethod)
void	setColoring(ColoringData coloring)
void	setDescription(String description) Set the description for the item.
void	setEntryDate(Date entryDate)
void	setExternalId(String externalId)
(package private) void	setExtraValues(Set<ExtraValueData> extraValues)
void	setName(String name) Set the name of the item.
void	setRemoved(boolean removed) Set the removed flag for this item.
void	setValueType(int valueType)

Methods inherited from class net.sf.basedb.core.data.BasicData

equals, getId, getVersion, hashCode, setId, setVersion, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.basedb.core.data.IdentifiableData

getId, getVersion

Field Detail

name

private String name

description

private String description

removed

private boolean removed

entryDate

private Date entryDate

MAX_EXTERNAL_ID_LENGTH

public static final int MAX_EXTERNAL_ID_LENGTH

The maximum length of the external id that can be stored in the database.

See Also:

setExternalId(String), Constant Field Values

externalId

private String externalId

valueType

private int valueType

coloring

private ColoringData coloring

averageMethod

private int averageMethod

extraValues

private Set<ExtraValueData> extraValues

Constructor Detail

ExtraValueTypeData

public ExtraValueTypeData()

Method Detail

getName

public String getName()

Description copied from interface: NameableData

Get the name of the item.

Specified by:

getName in interface NameableData

Returns:

A String with the name of the item

setName

public void setName(String name)

Description copied from interface: NameableData

Set the name of the item. The name cannot be null and mustn't be longer than the value specified by the MAX_NAME_LENGTH constant.

Specified by:

setName in interface NameableData

Parameters:

name - The new name for the item

getDescription

public String getDescription()

Description copied from interface: NameableData

Get the description for the item.

Specified by:

getDescription in interface NameableData

Returns:

A String with a description of the item

setDescription

public void setDescription(String description)

Description copied from interface: NameableData

Set the description for the item. The description can be null but mustn't be longer than the value specified by the MAX_DESCRIPTION_LENGTH constant.

Specified by:

setDescription in interface NameableData

Parameters:

description - The new description for the item

isRemoved

public boolean isRemoved()

Description copied from interface: RemovableData

Check if the removed flag is set for this item.

Specified by:

isRemoved in interface RemovableData

Returns:

TRUE if the item is flagged as removed, FALSE otherwise

setRemoved

public void setRemoved(boolean removed)

Description copied from interface: RemovableData

Set the removed flag for this item.

Specified by:

setRemoved in interface RemovableData

Parameters:

removed - TRUE if the item should be flagged as removed, FALSE otherwise

getEntryDate

public Date getEntryDate()

Description copied from interface: RegisteredData

Get the date this item was added to the database. The value is generated at creation time and can't be modified later.

Specified by:

getEntryDate in interface RegisteredData

setEntryDate

public void setEntryDate(Date entryDate)

getExternalId

public String getExternalId()

Get the external id for this ExtraValueType item.

Hibernate: property

column="`external_id`" type="string" length="255" not-null="true" unique="true"

setExternalId

public void setExternalId(String externalId)

getValueType

public int getValueType()

The code for the value type.

Hibernate: property

column="`value_type`" type="int" not-null="true" update="false"

setValueType

public void setValueType(int valueType)

getColoring

public ColoringData getColoring()

Get the coloring information for this extra value type.

Hibernate: component

setColoring

public void setColoring(ColoringData coloring)

getAverageMethod

public int getAverageMethod()

The average method for thid formula:

• 0 = none, Formula.AverageMethod.NONE; no average is defined for this formula
• 1 = geometric mean, Formula.AverageMethod.GEOMETRIC_MEAN; this formula uses geometric mean
• 2 = arithmetic mean, Formula.AverageMethod.ARITHMETIC_MEAN; this formula uses arithmetic mean
• 3 = min, Formula.AverageMethod.MIN; this formula uses the min value as a "mean"
• 4 = max, Formula.AverageMethod.MAX; this formula uses the max value as a "mean"

Since:

2.4

Hibernate: property

column="`average_method`" type="int" not-null="true"

setAverageMethod

public void setAverageMethod(int averageMethod)

getExtraValues

Set<ExtraValueData> getExtraValues()

This is the inverse end.

Since:

2.15

See Also:

ExtraValueData.getExtraValueType()

Hibernate: set

lazy="true" inverse="true"

Hibernate: collection-key

column="`extravaluetype_id`"

Hibernate: collection-one-to-many

class="net.sf.basedb.core.data.ExtraValueData"

setExtraValues

void setExtraValues(Set<ExtraValueData> extraValues)