Package 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: 2015-11-17 13:57:57 +0100 (ti, 17 nov 2015) $
- Hibernate: class
- table="`ExtraValueTypes`" lazy="true"
-
-
Field Summary
Fields Modifier and Type Field Description 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 Integer
removedBy
private int
valueType
-
Fields inherited from interface net.sf.basedb.core.data.NameableData
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
-
-
Constructor Summary
Constructors Constructor Description ExtraValueTypeData()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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 thisExtraValueType
item.(package private) Set<ExtraValueData>
getExtraValues()
This is the inverse end.String
getName()
Get the name of the item.Integer
getRemovedBy()
Get the ID of the user that removed this item.int
getValueType()
The code for the value type.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
setRemovedBy(Integer removedBy)
Set the ID of the user that removed this item or null to restore the 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
-
removedBy
private Integer removedBy
-
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
-
-
Method Detail
-
getName
public String getName()
Description copied from interface:NameableData
Get the name of the item.- Specified by:
getName
in interfaceNameableData
- 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 theMAX_NAME_LENGTH
constant.- Specified by:
setName
in interfaceNameableData
- 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 interfaceNameableData
- 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 theMAX_DESCRIPTION_LENGTH
constant.- Specified by:
setDescription
in interfaceNameableData
- Parameters:
description
- The new description for the item
-
getRemovedBy
public Integer getRemovedBy()
Description copied from interface:RemovableData
Get the ID of the user that removed this item.- Specified by:
getRemovedBy
in interfaceRemovableData
- Returns:
- The ID of a user or null if the item is not removed
-
setRemovedBy
public void setRemovedBy(Integer removedBy)
Description copied from interface:RemovableData
Set the ID of the user that removed this item or null to restore the item.- Specified by:
setRemovedBy
in interfaceRemovableData
-
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 interfaceRegisteredData
-
setEntryDate
public void setEntryDate(Date entryDate)
-
getExternalId
public String getExternalId()
Get the external id for thisExtraValueType
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"
- 0 = none,
-
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)
-
-