Package org.dcm4che.typeddicom.dataelements

Class DocumentTitle

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DocumentTitle

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortTextWrapper, StringDataElementWrapper

public class DocumentTitle
extends AbstractDataElementWrapper
implements ShortTextWrapper

Name: Document Title
Keyword: DocumentTitle
Tag: (0042,0010)
Value Representation: ST
Value Multiplicity: 1

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

  The title of the document.

  Note

  In the case of a PDF encapsulated document, this may be the value of the "Title" entry in the "Document Information Directory" as encoded in the PDF data.

  
  
• Described in the contexts:
  • Patient Medical Module > Pertinent Documents Sequence > Document Title
  as follows:
  Attribute Name: Document Title
  Type:
  Attribute Description:

  Title of the referenced document.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

exists, getValue

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

getValueRepresentation

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

DocumentTitle

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

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

Parameters:

attributes - The Attributes object to be wrapped.

DocumentTitle

public DocumentTitle()

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

Method Details

copy

public DocumentTitle copy()

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

Returns:

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

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.