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

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
All Implemented Interfaces:
com.fiveamsolutions.nci.commons.data.persistent.PersistentObject, UnitableValue, java.io.Serializable
Direct Known Subclasses:
MeasurementParameterValue, TermBasedParameterValue, UserDefinedParameterValue

public abstract class AbstractParameterValue
extends AbstractUnitableValue

A value for a parameter of a Protocol for a specific ProtocolApplication of that Protocol.

Author:
Rashmi Srinivasa
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
AbstractParameterValue()
          Default constructor.
AbstractParameterValue(AbstractParameterValue other)
          Constructs a new ParameterValue based on an existing one.
AbstractParameterValue(Term unit)
          Constructs a new ParameterValue with given unit.
 
Method Summary
 Parameter getParameter()
          Gets the parameter.
 ProtocolApplication getProtocolApplication()
           
 Term getUnit()
          Gets the unit.
 boolean matches(AbstractParameterValue other)
          Checks if two ParameterValues are the same, ignoring ProtocolApplications.
 void setParameter(Parameter parameterVal)
          Sets the parameter.
 void setProtocolApplication(ProtocolApplication protocolApplication)
           
 void setUnit(Term unitVal)
          Sets the unit.
 
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
getDisplayValueWithoutUnit
 

Constructor Detail

AbstractParameterValue

public AbstractParameterValue()
Default constructor.


AbstractParameterValue

public AbstractParameterValue(AbstractParameterValue other)
Constructs a new ParameterValue based on an existing one.

Parameters:
other - other ParameterValue to copy

AbstractParameterValue

public AbstractParameterValue(Term unit)
Constructs a new ParameterValue with given unit.

Parameters:
unit - the unit
Method Detail

getParameter

public Parameter getParameter()
Gets the parameter.

Returns:
the parameter

setParameter

public void setParameter(Parameter parameterVal)
Sets the parameter.

Parameters:
parameterVal - the parameter

getProtocolApplication

public ProtocolApplication getProtocolApplication()
Returns:
the protocolApplication

setProtocolApplication

public void setProtocolApplication(ProtocolApplication protocolApplication)
Parameters:
protocolApplication - the protocolApplication to set

getUnit

public Term getUnit()
Gets the unit.

Returns:
the unit

setUnit

public void setUnit(Term unitVal)
Sets the unit.

Parameters:
unitVal - the unit

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).

Parameters:
other - other ParameterValue to compare to
Returns:
true if they match