gov.nih.nci.caarray.domain.protocol
Class TermBasedParameterValue

java.lang.Object
  extended by gov.nih.nci.caarray.domain.AbstractCaArrayObject
      extended by gov.nih.nci.caarray.domain.AbstractCaArrayEntity
          extended by gov.nih.nci.caarray.domain.AbstractUnitableValue
              extended by gov.nih.nci.caarray.domain.protocol.AbstractParameterValue
                  extended by gov.nih.nci.caarray.domain.protocol.TermBasedParameterValue
All Implemented Interfaces:
com.fiveamsolutions.nci.commons.data.persistent.PersistentObject, TermBasedValue, UnitableValue, java.io.Serializable

public class TermBasedParameterValue
extends AbstractParameterValue
implements TermBasedValue

A parameter value with a controlled vocabulary term value.

Author:
dkokotov
See Also:
Serialized Form

Field Summary
 
Fields inherited from class gov.nih.nci.caarray.domain.AbstractCaArrayEntity
CAARRAY_LSID_AUTHORITY, CAARRAY_LSID_NAMESPACE
 
Fields inherited from class gov.nih.nci.caarray.domain.AbstractCaArrayObject
DEFAULT_BATCH_SIZE, DEFAULT_STRING_COLUMN_SIZE, LARGE_TEXT_FIELD_LENGTH
 
Constructor Summary
TermBasedParameterValue()
          Hibernate-only constructor.
TermBasedParameterValue(TermBasedParameterValue other)
          Copy constructor.
TermBasedParameterValue(Term term, Term unit)
          Create a new protocol value with given term and unit.
 
Method Summary
 java.lang.String getDisplayValueWithoutUnit()
          
 Term getTerm()
          Gets the term.
 boolean matches(AbstractParameterValue other)
          Checks if two ParameterValues are the same, ignoring ProtocolApplications.
 void setTerm(Term termVal)
          Sets the term.
 
Methods inherited from class gov.nih.nci.caarray.domain.protocol.AbstractParameterValue
getParameter, getProtocolApplication, getUnit, setParameter, setProtocolApplication, setUnit
 
Methods inherited from class gov.nih.nci.caarray.domain.AbstractUnitableValue
getDisplayValue
 
Methods inherited from class gov.nih.nci.caarray.domain.AbstractCaArrayEntity
getLsid, getLsidAuthority, getLsidNamespace, getLsidObjectId, setLsid, setLsid, setLsidForEntity
 
Methods inherited from class gov.nih.nci.caarray.domain.AbstractCaArrayObject
equals, getCaBigId, getId, getPostLoadSecurityPolicies, getRemoteApiSecurityPolicies, hashCode, setCaBigId, setId, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface gov.nih.nci.caarray.domain.UnitableValue
getDisplayValue, getUnit, setUnit
 

Constructor Detail

TermBasedParameterValue

public TermBasedParameterValue()
Hibernate-only constructor.


TermBasedParameterValue

public TermBasedParameterValue(TermBasedParameterValue other)
Copy constructor.

Parameters:
other - the value to copy from

TermBasedParameterValue

public TermBasedParameterValue(Term term,
                               Term unit)
Create a new protocol value with given term and unit.

Parameters:
term - the term
unit - the unit
Method Detail

getTerm

@NotNull
public Term getTerm()
Gets the term.

Specified by:
getTerm in interface TermBasedValue
Returns:
the term

setTerm

public void setTerm(Term termVal)
Sets the term.

Specified by:
setTerm in interface TermBasedValue
Parameters:
termVal - the term

getDisplayValueWithoutUnit

public java.lang.String getDisplayValueWithoutUnit()

Specified by:
getDisplayValueWithoutUnit in interface UnitableValue
Returns:
the value (without unit) as a string displayable in the ui

matches

public boolean matches(AbstractParameterValue other)
Checks if two ParameterValues are the same, ignoring ProtocolApplications. Subclasses should override to define additional checks (possibly calling super.matches).

Overrides:
matches in class AbstractParameterValue
Parameters:
other - other ParameterValue to compare to
Returns:
true if they match