Package com.pixelmed.dicom

Class AttributeTagAttribute

java.lang.Object
com.pixelmed.dicom.Attribute
com.pixelmed.dicom.AttributeTagAttribute
public class AttributeTagAttribute extends Attribute

A concrete class specializing Attribute for Attribute Tag (AT) attributes.

Though an instance of this class may be created using its constructors, there is also a factory class, AttributeFactory.

See Also:

  • Constructor Details

    • AttributeTagAttribute

      public AttributeTagAttribute(AttributeTag t)

      Construct an (empty) attribute.

      Parameters:
      t - the tag of the attribute

    • AttributeTagAttribute

      public AttributeTagAttribute(AttributeTag t, long vl, DicomInputStream i) throws IOException, DicomException

      Read an attribute from an input stream.

      Parameters:
      t - the tag of the attribute
      vl - the value length of the attribute
      i - the input stream
      Throws:
      IOException - if an I/O error occurs
      DicomException - if error in DICOM encoding

    • AttributeTagAttribute

      public AttributeTagAttribute(AttributeTag t, Long vl, DicomInputStream i) throws IOException, DicomException

      Read an attribute from an input stream.

      Parameters:
      t - the tag of the attribute
      vl - the value length of the attribute
      i - the input stream
      Throws:
      IOException - if an I/O error occurs
      DicomException - if error in DICOM encoding

  • Method Details

    • write

      public void write(DicomOutputStream o) throws DicomException, IOException
      Description copied from class: Attribute

      Write the entire attribute (including values) to the output stream.

      Specified by:
      write in class Attribute
      Parameters:
      o - the output stream
      Throws:
      DicomException - if error in DICOM encoding
      IOException - if an I/O error occurs

    • toString

      public String toString(DicomDictionary dictionary)
      Description copied from class: Attribute

      Dump the contents of the attribute as a human-readable string.

      No new line is appended.

      The result is of the form:

       (0xgggg,0xeeee) Name VR=<XX> VL=<0xnnnn> <...>

      For example:

       (0x0018,0x0020) ScanningSequence VR=<CS> VL=<0x2> <GR>
      Overrides:
      toString in class Attribute
      Parameters:
      dictionary - the dictionary to use to look up the name
      Returns:
      a single String value

    • getStringValues

      public String[] getStringValues(NumberFormat format) throws DicomException
      Description copied from class: Attribute

      Get the values of this attribute as strings.

      The strings may have been cleaned up into a canonical form, such as to remove padding as well as numbers formatted.

      Overrides:
      getStringValues in class Attribute
      Parameters:
      format - the format to use for each numerical or decimal value
      Returns:
      the values as an array of String
      Throws:
      DicomException - thrown if values are not available (such as not supported for this concrete attribute class)

    • getAttributeTagValues

      public AttributeTag[] getAttributeTagValues() throws DicomException
      Returns:
      the values
      Throws:
      DicomException - thrown if values are not available

    • addValue

      public void addValue(int g, int e) throws DicomException
      Parameters:
      g - group number
      e - element number
      Throws:
      DicomException - never thrown

    • addValue

      public void addValue(AttributeTag t) throws DicomException
      Parameters:
      t - the tag
      Throws:
      DicomException - never thrown

    • addValue

      public void addValue(String s) throws DicomException
      Description copied from class: Attribute
      Add a(nother) String value after any existing values of this attribute.
      Overrides:
      addValue in class Attribute
      Parameters:
      s - a String of the form returned by toString(), i.e., "(0xgggg,0xeeee)" where gggg and eeee are the zero-padded hexadecimal representations of the group and element respectively
      Throws:
      DicomException - if String is not a valid representation of a tag

    • removeValues

      public void removeValues()
      Description copied from class: Attribute

      Remove any existing values, making the attribute empty (zero length).

      Specified by:
      removeValues in class Attribute

    • getVR

      public byte[] getVR()

      Get the value representation of this attribute (AT).

      Overrides:
      getVR in class Attribute
      Returns:
      'A','T' in ASCII as a two byte array; see ValueRepresentation