Package org.dcm4che.typeddicom.dataelements

Class RelationshipType

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RelationshipType

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class RelationshipType
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Relationship Type
Keyword: RelationshipType
Tag: (0040,A010)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Document Relationship Macro > Content Sequence > Relationship Type
  as follows:
  Attribute Name: Relationship Type
  Type: 1
  Attribute Description:

  The type of relationship between the (enclosing) Source Content Item and the Target Content Item.

  IODs specify additional constraints on Relationships (including lists of Enumerated Values).

  Enumerated Values:

  CONTAINS

  HAS PROPERTIES

  HAS OBS CONTEXT

  HAS ACQ CONTEXT

  INFERRED FROM

  SELECTED FROM

  HAS CONCEPT MOD

  See DICOM Standard Part 3 - Section C.17.3.2.4 for further explanation.

  
  
• Described in the contexts:
  • Encapsulated Document Module > Content Sequence > Relationship Type
  as follows:
  Attribute Name: Relationship Type
  Type: 1
  Attribute Description:

  The type of relationship between the (enclosing) Source Content Item and the Target Content Item.

  IODs specify additional constraints on Relationships (including lists of Enumerated Values).

  Enumerated Values:

  CONTAINS

  HAS OBS CONTEXT

  HAS ACQ CONTEXT

  HAS CONCEPT MOD

  See DICOM Standard Part 3 - Section C.17.3.2.4 for further explanation.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RelationshipType.Builder<SELF extends RelationshipType.Builder<SELF,T>,T extends RelationshipType.Holder>
static interface	RelationshipType.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Relationship Type" (see RelationshipType)
static class	RelationshipType.SimpleHolder

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

CodeStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends CodeStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRIVATE_CREATOR	The Private Creator associated with this class.
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
RelationshipType()	Creates a new Relationship Type object which wraps a new and empty Attributes object.
RelationshipType(org.dcm4che3.data.Attributes attributes)	Creates a new Relationship Type object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
RelationshipType	copy()	Returns a new Relationship Type which wraps a copy of the Attributes wrapped in this Relationship Type.
String	getPrivateCreator()
int	getTag()

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

equals, exists, getValue, hashCode, toString

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

getAttributes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

getString, setString

Field Details

PRIVATE_CREATOR

public static final String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

RelationshipType

public RelationshipType(org.dcm4che3.data.Attributes attributes)

Creates a new Relationship Type object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RelationshipType

public RelationshipType()

Creates a new Relationship Type object which wraps a new and empty Attributes object.

Method Details

copy

public RelationshipType copy()

Returns a new Relationship Type which wraps a copy of the Attributes wrapped in this Relationship Type. (see Attributes(Attributes)

Returns:

a new Relationship Type which wraps a copy of the Attributes wrapped in this Relationship Type.

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.