Package org.dcm4che.typeddicom.dataelements

Class ReferencedFileID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedFileID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringMultiWrapper, StringDataElementMultiWrapper

public class ReferencedFileID
extends AbstractDataElementWrapper
implements CodeStringMultiWrapper

Name: Referenced File ID
Keyword: ReferencedFileID
Tag: (0004,1500)
Value Representation: CS
Value Multiplicity: 1-8

• Described in the contexts:
  • Directory Information Module > Directory Record Sequence > Referenced File ID
  as follows:
  Attribute Name: Referenced File ID
  Type: 1C
  Attribute Description:

  A Multiple Value (see PS3.5 PS3.5) that represents the ordered components of the File ID containing a "referenced object" or Referenced SOP Instance. A maximum of 8 components, each from 1 to 8 characters shall be used (see DICOM Standard Part 3 - Section 8.2).

  Note

  The Referenced File ID provides the means to "locate" the File through the DICOM File Service provided by the Media Format Layer.

  All referenced Files shall be with the File-set to which the Directory belongs. Any File within the File-set (to which the Directory belongs) shall be referenced by at most one Directory Record. When the Directory Record does not reference any SOP Instance this Attribute shall not be present.

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ReferencedFileID()	Creates a new Referenced File ID object which wraps a new and empty Attributes object.
ReferencedFileID(org.dcm4che3.data.Attributes attributes)	Creates a new Referenced File ID object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ReferencedFileID	copy()	Returns a new Referenced File ID which wraps a copy of the Attributes wrapped in this Referenced File ID.
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.CodeStringMultiWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getPrivateCreator, getValue

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

getString, getString, getStrings, setStrings

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

ReferencedFileID

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

Creates a new Referenced File ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ReferencedFileID

public ReferencedFileID()

Creates a new Referenced File ID object which wraps a new and empty Attributes object.

Method Details

copy

public ReferencedFileID copy()

Returns a new Referenced File ID which wraps a copy of the Attributes wrapped in this Referenced File ID. (see Attributes(Attributes)

Returns:

a new Referenced File ID which wraps a copy of the Attributes wrapped in this Referenced File ID.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.