gov.nih.nlm.umls.meta.impl
Class AttributeValueImpl

java.lang.Object
  extended bygov.nih.nlm.umls.meta.impl.AttributeValueImpl
All Implemented Interfaces:
AttributeElement, AttributeValue, Comparable, ContentViewElement, SuppressibleElement

public class AttributeValueImpl
extends Object
implements AttributeValue

Default implementation of the AttributeValue interface.

Author:
Brian Carlsen, Deborah Shapiro

Constructor Summary
AttributeValueImpl()
          Instantiates an empty AttributeValue.
AttributeValueImpl(AttributeValue att)
          Instantiates a AttributeValue from the specified AttributeValue.
 
Method Summary
 int compareTo(Object o)
          Compares this AttributeValue to another one.
 boolean equals(Object o)
          Returns true if the specified object is equal to this object.
 AttributeName getAtn()
          Shorthand for getAttributeName().
 String getAttributeIdentifier()
          Returns the unique identifier (ATUI).
 AttributeName getAttributeName()
          Returns the AttributeName (ATN).
 String getAttributeValue()
          Returns the attribute value (ATV).
 String getAtui()
          Returns the unique identifier (ATUI).
 String getAtv()
          Shorthand for getAttributeValue().
 ContentView getContentView()
          Returns tbe ContentView definition for this AttributeValue (CVF).
 ContentView getCvf()
          Shorthand for getContentView().
 String getKeyFields()
          Returns a String key which can be used by equals, compareTo, and hashCode methods.
 String getSatui()
          Shorthand for getSourceAttributeIdentifier().
 String getSourceAttributeIdentifier()
          Returns the source asserted attribute identifier (SATUI).
 Suppressible getSuppress()
          Returns the suppressibility value (SUPPRESS).
 int hashCode()
          Return a hash code based on key fields.
 boolean isObsolete()
          Indicates whether or not this AttributeValueImpl is obsolete.
 boolean isSuppressible()
          Indicates whether or not this AttributeValue is suppressible.
 void setAtn(AttributeName atn)
          Shorthand for setAttributeName(AttributeName).
 void setAttributeIdentifier(String atui)
          Sets the unique identifier (ATUI).
 void setAttributeName(AttributeName atn)
          Sets the AttributeName (ATN).
 void setAttributeValue(String atv)
          Sets the attribute value (ATV).
 void setAtui(String atui)
          Shorthand for setAttributeIdentifier(String).
 void setAtv(String atv)
          Shorthand for setAttributeValue(String).
 void setContentView(ContentView cvf)
          Sets tbe ContentView definition for this AttributeValue (CVF).
 void setCvf(ContentView cvf)
          Shorthand for setContentView(ContentView).
 void setSatui(String satui)
          Shorthand for setSourceAttributeIdentifier(String).
 void setSourceAttributeIdentifier(String satui)
          Sets the source asserted attribute identifier (SATUI).
 void setSuppress(Suppressible suppress)
          Sets the suppressibility value (SUPPRESS).
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AttributeValueImpl

public AttributeValueImpl()
Instantiates an empty AttributeValue.


AttributeValueImpl

public AttributeValueImpl(AttributeValue att)
Instantiates a AttributeValue from the specified AttributeValue.

Parameters:
att - AttributeValue to be copied
Method Detail

getAttributeName

public AttributeName getAttributeName()
Returns the AttributeName (ATN).

Specified by:
getAttributeName in interface AttributeValue
Returns:
the AttributeName

getAtn

public AttributeName getAtn()
Shorthand for getAttributeName().

Specified by:
getAtn in interface AttributeValue
Returns:
the AttributeName

setAttributeName

public void setAttributeName(AttributeName atn)
Sets the AttributeName (ATN).

Specified by:
setAttributeName in interface AttributeValue
Parameters:
atn - the AttributeName

setAtn

public void setAtn(AttributeName atn)
Shorthand for setAttributeName(AttributeName).

Specified by:
setAtn in interface AttributeValue
Parameters:
atn - the AttributeName

getAttributeValue

public String getAttributeValue()
Returns the attribute value (ATV).

Specified by:
getAttributeValue in interface AttributeValue
Returns:
the attribute value

getAtv

public String getAtv()
Shorthand for getAttributeValue().

Specified by:
getAtv in interface AttributeValue
Returns:
the attribute value

setAttributeValue

public void setAttributeValue(String atv)
Sets the attribute value (ATV).

Specified by:
setAttributeValue in interface AttributeValue
Parameters:
atv - the attribute value

setAtv

public void setAtv(String atv)
Shorthand for setAttributeValue(String).

Specified by:
setAtv in interface AttributeValue
Parameters:
atv - the attribute value

getSourceAttributeIdentifier

public String getSourceAttributeIdentifier()
Returns the source asserted attribute identifier (SATUI).

Specified by:
getSourceAttributeIdentifier in interface AttributeElement
Returns:
the SATUI

getSatui

public String getSatui()
Shorthand for getSourceAttributeIdentifier().

Specified by:
getSatui in interface AttributeElement
Returns:
the SATUI

setSourceAttributeIdentifier

public void setSourceAttributeIdentifier(String satui)
Sets the source asserted attribute identifier (SATUI).

Specified by:
setSourceAttributeIdentifier in interface AttributeElement
Parameters:
satui - the SATUI

setSatui

public void setSatui(String satui)
Shorthand for setSourceAttributeIdentifier(String).

Specified by:
setSatui in interface AttributeElement
Parameters:
satui - the SATUI

getAttributeIdentifier

public String getAttributeIdentifier()
Returns the unique identifier (ATUI).

Specified by:
getAttributeIdentifier in interface AttributeElement
Returns:
the ATUI

getAtui

public String getAtui()
Returns the unique identifier (ATUI). This is shorthand for getAttributeIdentifier().

Specified by:
getAtui in interface AttributeElement
Returns:
the ATUI

setAttributeIdentifier

public void setAttributeIdentifier(String atui)
Sets the unique identifier (ATUI).

Specified by:
setAttributeIdentifier in interface AttributeElement
Parameters:
atui - the ATUI

setAtui

public void setAtui(String atui)
Shorthand for setAttributeIdentifier(String).

Specified by:
setAtui in interface AttributeElement
Parameters:
atui - the ATUI

getSuppress

public Suppressible getSuppress()
Returns the suppressibility value (SUPPRESS).

Specified by:
getSuppress in interface SuppressibleElement
Returns:
the Suppressible value

isSuppressible

public boolean isSuppressible()
Indicates whether or not this AttributeValue is suppressible.

Specified by:
isSuppressible in interface SuppressibleElement
Returns:
true if suppressible, false if not suppressible

setSuppress

public void setSuppress(Suppressible suppress)
Sets the suppressibility value (SUPPRESS).

Specified by:
setSuppress in interface SuppressibleElement
Parameters:
suppress - the Suppressible value

isObsolete

public boolean isObsolete()
Indicates whether or not this AttributeValueImpl is obsolete.

Specified by:
isObsolete in interface SuppressibleElement
Returns:
true if obsolete, false if not obsolete

getContentView

public ContentView getContentView()
Returns tbe ContentView definition for this AttributeValue (CVF).

Specified by:
getContentView in interface ContentViewElement
Returns:
tbe ContentView definition

setContentView

public void setContentView(ContentView cvf)
Sets tbe ContentView definition for this AttributeValue (CVF).

Specified by:
setContentView in interface ContentViewElement
Parameters:
cvf - the ContentView definition

getCvf

public ContentView getCvf()
Shorthand for getContentView().

Specified by:
getCvf in interface ContentViewElement
Returns:
tbe ContentView definition

setCvf

public void setCvf(ContentView cvf)
Shorthand for setContentView(ContentView).

Specified by:
setCvf in interface ContentViewElement
Parameters:
cvf - the ContentView definition

getKeyFields

public String getKeyFields()
Returns a String key which can be used by equals, compareTo, and hashCode methods.

Specified by:
getKeyFields in interface AttributeValue
Returns:
a String composed from the atn and atv.

hashCode

public int hashCode()
Return a hash code based on key fields.

Returns:
a hash code based on key fields

equals

public boolean equals(Object o)
Returns true if the specified object is equal to this object. The specified object must be an AttributeValue with matching key fields.

Parameters:
o - an Object to compare against
Returns:
boolean true if Object o is equal false otherwise

compareTo

public int compareTo(Object o)
Compares this AttributeValue to another one. Results are indeterminate if the specified parameter is not of the same class.

Specified by:
compareTo in interface Comparable
Parameters:
o - the Object to compare to
Returns:
int representing the relative ordering of this and the compare-to object


Copyright ©2005