net.sf.basedb.core.data
Class QuantityData

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

All Implemented Interfaces:

IdentifiableData, NameableData, RemovableData, SystemData

public class QuantityData
extends BasicData
implements NameableData, RemovableData, SystemData

This class holds information quantities.

Version:

2.9

Author:

Nicklas

See Also:

Quantity, Developer documentation: Annotations

Last modified

$Date $

Hibernate: class

table="`Quantities`" lazy="true"

Field Summary

private String	description
static int	MAX_REFERENCE_UNIT_LENGTH
private String	name
private String	referenceUnit
private boolean	removed
private Set<UnitSymbolData>	symbols
private String	systemId
private Set<UnitData>	units

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

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

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

MAX_SYSTEM_ID_LENGTH

Constructor Summary

QuantityData()

Method Summary

String	getDescription() Get the description for the item.
String	getName() Get the name of the item.
String	getReferenceUnit() The reference unit that all units of must relate to.
(package private) Set<UnitSymbolData>	getSymbols() This is the inverse end.
String	getSystemId() Get the system id for the item.
(package private) Set<UnitData>	getUnits() This is the inverse end.
boolean	isRemoved() Check if the removed flag is set for this item.
void	setDescription(String description) Set the description for the item.
void	setName(String name) Set the name of the item.
void	setReferenceUnit(String referenceUnit)
void	setRemoved(boolean removed) Set the removed flag for this item.
(package private) void	setSymbols(Set<UnitSymbolData> symbols)
void	setSystemId(String systemId)
(package private) void	setUnits(Set<UnitData> units)

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

systemId

private String systemId

MAX_REFERENCE_UNIT_LENGTH

public static final int MAX_REFERENCE_UNIT_LENGTH

See Also:

Constant Field Values

referenceUnit

private String referenceUnit

units

private Set<UnitData> units

symbols

private Set<UnitSymbolData> symbols

Constructor Detail

QuantityData

public QuantityData()

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

getSystemId

public String getSystemId()

Description copied from interface: SystemData

Get the system id for the item.

Specified by:

getSystemId in interface SystemData

Returns:

The id of the item or null

setSystemId

public void setSystemId(String systemId)

getReferenceUnit

public String getReferenceUnit()

The reference unit that all units of must relate to.

Hibernate: property

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

setReferenceUnit

public void setReferenceUnit(String referenceUnit)

getUnits

Set<UnitData> getUnits()

This is the inverse end.

See Also:

UnitData.getQuantity()

Hibernate: set

lazy="true" inverse="true"

Hibernate: collection-key

column="`quantity_id`"

Hibernate: collection-one-to-many

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

setUnits

void setUnits(Set<UnitData> units)

getSymbols

Set<UnitSymbolData> getSymbols()

This is the inverse end.

See Also:

UnitSymbolData.getQuantity()

Hibernate: set

lazy="true" inverse="true"

Hibernate: collection-key

column="`quantity_id`"

Hibernate: collection-one-to-many

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

setSymbols

void setSymbols(Set<UnitSymbolData> symbols)