Package org.dcm4che.typeddicom.dataelements

Class EncapsulatedDocument

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.EncapsulatedDocument

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, OtherByteWrapper

public class EncapsulatedDocument
extends AbstractDataElementWrapper
implements OtherByteWrapper

Name: Encapsulated Document
Keyword: EncapsulatedDocument
Tag: (0042,0011)
Value Representation: OB
Value Multiplicity: 1

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

  Encapsulated Document stream, containing a document encoded according to the MIME Type.

  
  
• Described in the contexts:
  • Generic Implant Template Description Module > Notification From Manufacturer Sequence > Encapsulated Document
  as follows:
  Attribute Name: Encapsulated Document
  Type: 3
  Attribute Description:

  The complete manufacturer notification describing the template.

  Encapsulated Document stream, containing a document encoded according to the MIME Type.

  
  
• Described in the contexts:
  • Generic Implant Template Description Module > Information From Manufacturer Sequence > Encapsulated Document
  as follows:
  Attribute Name: Encapsulated Document
  Type: 3
  Attribute Description:

  Encapsulated Document stream, containing a document encoded according to the MIME Type.

  The complete manufacturer information.

  
  
• Described in the contexts:
  • Implant Assembly Template Module > Encapsulated Document
  as follows:
  Attribute Name: Encapsulated Document
  Type: 2
  Attribute Description:

  Encapsulated Document stream, containing a document encoded according to the MIME Type.

  PDF description of the surgical technique.

  
  

Nested Class Summary

Nested Classes

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

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

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

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.OtherByteWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
EncapsulatedDocument()	Creates a new Encapsulated Document object which wraps a new and empty Attributes object.
EncapsulatedDocument(org.dcm4che3.data.Attributes attributes)	Creates a new Encapsulated Document object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
EncapsulatedDocument	copy()	Returns a new Encapsulated Document which wraps a copy of the Attributes wrapped in this Encapsulated Document.
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.DataElementWrapper

exists, getPrivateCreator, getValue

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

getValueRepresentation

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

EncapsulatedDocument

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

Creates a new Encapsulated Document object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

EncapsulatedDocument

public EncapsulatedDocument()

Creates a new Encapsulated Document object which wraps a new and empty Attributes object.

Method Details

copy

public EncapsulatedDocument copy()

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

Returns:

a new Encapsulated Document which wraps a copy of the Attributes wrapped in this Encapsulated Document.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.