Class ContentItemWithValue

java.lang.Object
com.pixelmed.dicom.ContentItem
com.pixelmed.dicom.ContentItemWithValue
All Implemented Interfaces:
TreeNode
Direct Known Subclasses:
ContentItemFactory.CodeContentItem, ContentItemFactory.CompositeContentItem, ContentItemFactory.ContainerContentItem, ContentItemFactory.NumericContentItem, ContentItemFactory.SpatialCoordinates3DContentItem, ContentItemFactory.SpatialCoordinatesContentItem, ContentItemFactory.StringContentItem, ContentItemFactory.TemporalCoordinatesContentItem, ContentItemFactory.UnrecognizedContentItem

public abstract class ContentItemWithValue extends ContentItem

An abstract class for representing a node in an internal representation of a structured reporting tree (an instance of StructuredReport).

The constructor is protected. Instances of specific types of content items should normally be created by using the ContentItemFactory.

See Also:
  • Field Details

    • valueType

      protected String valueType
    • conceptName

      protected CodedSequenceItem conceptName
    • referencedContentItemIdentifier

      protected String referencedContentItemIdentifier
  • Constructor Details

    • ContentItemWithValue

      protected ContentItemWithValue(ContentItem p, AttributeList l)

      Construct a content item for a list of attributes, and add it as a child of the specified parent.

      The constructor is protected. Instances of specific types of content items should normally be created by using the ContentItemFactory.

      Parameters:
      p - the parent
      l - the list of attributes
    • ContentItemWithValue

      protected ContentItemWithValue(ContentItem p, String valueType, String relationshipType, CodedSequenceItem conceptName, String observationDateTime, String observationUID) throws DicomException

      Construct a content item of a specified type and relationship, creating a new AttributeList, and add it as a child of the specified parent.

      The constructor is protected. Instances of specific types of content items should normally be created by using the ContentItemFactory.

      Parameters:
      p - the parent
      valueType - value type
      relationshipType - added only if not null or zero length
      conceptName - coded concept name
      observationDateTime - Observation DateTime, if any
      observationUID - Observation UID, if any
      Throws:
      DicomException - if error in DICOM encoding
    • ContentItemWithValue

      protected ContentItemWithValue(ContentItem p, String valueType, String relationshipType, CodedSequenceItem conceptName) throws DicomException

      Construct a content item of a specified type and relationship, creating a new AttributeList, and add it as a child of the specified parent.

      The constructor is protected. Instances of specific types of content items should normally be created by using the ContentItemFactory.

      Parameters:
      p - the parent
      valueType - value type
      relationshipType - added only if not null or zero length
      conceptName - coded concept name
      Throws:
      DicomException - if error in DICOM encoding
  • Method Details

    • getValueType

      public String getValueType()

      Get the value type of this content item.

      Overrides:
      getValueType in class ContentItem
      Returns:
      the value type (the string used in the DICOM standard in the Value Type attribute)
    • getConceptNameAndValue

      public String getConceptNameAndValue()

      Get a string representation of the concept name and the value of the concept.

      The exact form of the returned string is specific to the type of ContentItem.

      Overrides:
      getConceptNameAndValue in class ContentItem
      Returns:
      a String representation of the name and value, or an empty string
    • getConceptValue

      public abstract String getConceptValue()

      Get a string representation of the value of the concept.

      The exact form of the returned string is specific to the type of ContentItem.

      Specified by:
      getConceptValue in class ContentItem
      Returns:
      a String representation of the name and value, or an empty string
    • getConceptName

      public CodedSequenceItem getConceptName()

      Get the Concept Name.

      Overrides:
      getConceptName in class ContentItem
      Returns:
      the Concept Name
    • getConceptNameCodeMeaning

      public String getConceptNameCodeMeaning()

      Get the value of the code meaning of the Concept Name as a string, if present and applicable.

      Overrides:
      getConceptNameCodeMeaning in class ContentItem
      Returns:
      the code meaning of the Concept Name, or an empty string
    • getConceptNameCodeValue

      public String getConceptNameCodeValue()

      Get the value of the code value of the Concept Name as a string, if present and applicable.

      Overrides:
      getConceptNameCodeValue in class ContentItem
      Returns:
      the code value of the Concept Name, or an empty string
    • getConceptNameCodingSchemeDesignator

      public String getConceptNameCodingSchemeDesignator()

      Get the value of the coding scheme designator of the Concept Name as a string, if present and applicable.

      Overrides:
      getConceptNameCodingSchemeDesignator in class ContentItem
      Returns:
      the coding scheme designator of the Concept Name, or an empty string
    • toString

      public String toString()

      Get a human-readable string representation of the content item.

      Overrides:
      toString in class Object
      Returns:
      the string representation of the content item
    • contentItemNameMatchesCodeValueAndCodingSchemeDesignator

      public boolean contentItemNameMatchesCodeValueAndCodingSchemeDesignator(String cvWanted, String csdWanted)
      Description copied from class: ContentItem
      Test if the coded concept name of the content item matches the specified code value and coding scheme designator. This is more robust than checking code meaning, which may have synomyms, and there is no need to also test code meaning. Does NOT follow references.
      Specified by:
      contentItemNameMatchesCodeValueAndCodingSchemeDesignator in class ContentItem
      Parameters:
      cvWanted - the code value wanted
      csdWanted - the coding scheme designator wanted
      Returns:
      true if matches