DirectDocument2.Metadata (NHIN Direct XD* Common Library 8.1.0 API)

java.lang.Object
- org.nhindirect.xd.common.DirectDocument2.Metadata

Enclosing class:

DirectDocument2
```
public static class DirectDocument2.Metadata
extends Object
```
Abstract representation of document metadata.

Author:

beau

Constructor Summary

Constructors
Constructor and Description

Metadata()
Default constructor.

Metadata(File file)
Construct a new DirectDocument2.Metadata with default values given a File object.

Constructors
Constructor and Description
`Metadata()` Default constructor.
`Metadata(File file)` Construct a new DirectDocument2.Metadata with default values given a File object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`getAuthorInstitution()`
`String`	`getAuthorPerson()`
`String`	`getAuthorRole()`
`String`	`getAuthorSpecialty()`
`String`	`getClassCode_localized()`
`String`	`getClassCode()`
`String`	`getConfidentialityCode_localized()`
`String`	`getConfidentialityCode()`
`Date`	`getCreationTime()`
`String`	`getDescription()`
`String`	`getFormatCode_localized()`
`String`	`getFormatCode()`
`String`	`getHash()`
`String`	`getHealthcareFacilityTypeCode_localized()`
`String`	`getHealthcareFacilityTypeCode()`
`String`	`getId()`
`String`	`getLanguageCode()`
`String`	`getLoinc_localized()`
`String`	`getLoinc()`
`String`	`getMimeType()`
`String`	`getPatientId()`
`String`	`getPracticeSettingCode_localized()`
`String`	`getPracticeSettingCode()`
`Date`	`getServiceStartTime()`
`Date`	`getServiceStopTime()`
`Long`	`getSize()`
`SimplePerson`	`getSourcePatient()`
`String`	`getSubmissionSetStatus()`
`String`	`getUniqueId()`
`String`	`getURI()`
`void`	`setAuthorInstitution(List<String> authorInstitution)`
`void`	`setAuthorPerson(String authorPerson)`
`void`	`setAuthorRole(String authorRole)`
`void`	`setAuthorSpecialty(String authorSpecialty)`
`void`	`setClassCode_localized(String classCodeLocalized)`
`void`	`setClassCode(String classCode)`
`void`	`setClassCode(String classCode, boolean setLocalized)`
`void`	`setConfidentialityCode_localized(String confidentialityCodeLocalized)`
`void`	`setConfidentialityCode(String confidentialityCode)`
`void`	`setConfidentialityCode(String confidentialityCode, boolean setLocalized)`
`void`	`setCreationTime(Date creationTime)`
`void`	`setDescription(String description)`
`void`	`setFormatCode_localized(String formatCodeLocalized)`
`void`	`setFormatCode(FormatCodeEnum formatCode)`
`void`	`setFormatCode(String formatCode)`
`void`	`setFormatCode(String formatCode, boolean setLocalized)`
`void`	`setHash(String hash)`
`void`	`setHealthcareFacilityTypeCode_localized(String healthcareFacilityTypeCodeLocalized)`
`void`	`setHealthcareFacilityTypeCode(String healthcareFacilityTypeCode)`
`void`	`setHealthcareFacilityTypeCode(String healthcareFacilityTypeCode, boolean setLocalized)`
`void`	`setId(String id)`
`void`	`setLanguageCode(String languageCode)`
`void`	`setLoinc_localized(String loincLocalized)`
`void`	`setLoinc(String loinc)`
`void`	`setLoinc(String loinc, boolean setLocalized)`
`void`	`setMimeType(String mimeType)`
`void`	`setPatientId(String patientId)`
`void`	`setPracticeSettingCode_localized(String practiceSettingCodeLocalized)`
`void`	`setPracticeSettingCode(String practiceSettingCode)`
`void`	`setPracticeSettingCode(String practiceSettingCode, boolean setLocalized)`
`void`	`setServiceStartTime(Date serviceStartTime)`
`void`	`setServiceStopTime(Date serviceStopTime)`
`void`	`setSize(Long size)`
`void`	`setSourcePatient(SimplePerson sourcePatient)`
`void`	`setSubmissionSetStatus(String submissionSetStatus)`
`void`	`setUniqueId(String uniqueId)`
`void`	`setURI(String uri)`
`void`	`setValues(ExtrinsicObjectType eot)`
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Metadata
```
public Metadata()
```
    Default constructor.
  - Metadata
```
public Metadata(File file)
         throws IOException
```
    Construct a new DirectDocument2.Metadata with default values given a File object.
    
    Parameters:
    
    file - A File object from which to extract metadata.
    
    Throws:
    
    IOException
- Method Detail
  - setValues
```
public void setValues(ExtrinsicObjectType eot)
               throws MetadataException
```
    Throws:
    
    MetadataException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getMimeType
```
public String getMimeType()
```
    Returns:
    
    the mimeType
  - setMimeType
```
public void setMimeType(String mimeType)
```
    Parameters:
    
    mimeType - the mimeType to set
  - getId
```
public String getId()
```
    Returns:
    
    the id
  - setId
```
public void setId(String id)
```
    Parameters:
    
    id - The id to set.
  - getDescription
```
public String getDescription()
```
    Returns:
    
    the description
  - setDescription
```
public void setDescription(String description)
```
    Parameters:
    
    description - the description to set
  - getCreationTime
```
public Date getCreationTime()
```
    Returns:
    
    the creationTime
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    Parameters:
    
    creationTime - the creationTime to set
  - getLanguageCode
```
public String getLanguageCode()
```
    Returns:
    
    the languageCode
  - setLanguageCode
```
public void setLanguageCode(String languageCode)
```
    Parameters:
    
    languageCode - the languageCode to set
  - getServiceStartTime
```
public Date getServiceStartTime()
```
    Returns:
    
    the serviceStartTime
  - setServiceStartTime
```
public void setServiceStartTime(Date serviceStartTime)
```
    Parameters:
    
    serviceStartTime - the serviceStartTime to set
  - getServiceStopTime
```
public Date getServiceStopTime()
```
    Returns:
    
    the serviceStopTime
  - setServiceStopTime
```
public void setServiceStopTime(Date serviceStopTime)
```
    Parameters:
    
    serviceStopTime - the serviceStopTime to set
  - getSourcePatient
```
public SimplePerson getSourcePatient()
```
    Returns:
    
    the sourcePatient
  - setSourcePatient
```
public void setSourcePatient(SimplePerson sourcePatient)
```
    Parameters:
    
    sourcePatient - the sourcePatient to set
  - getAuthorPerson
```
public String getAuthorPerson()
```
    Returns:
    
    the authorPerson
  - setAuthorPerson
```
public void setAuthorPerson(String authorPerson)
```
    Parameters:
    
    authorPerson - the authorPerson to set
  - getAuthorInstitution
```
public List<String> getAuthorInstitution()
```
    Returns:
    
    the authorInstitution
  - setAuthorInstitution
```
public void setAuthorInstitution(List<String> authorInstitution)
```
    Parameters:
    
    authorInstitution - the authorInstitution to set
  - getAuthorRole
```
public String getAuthorRole()
```
    Returns:
    
    the authorRole
  - setAuthorRole
```
public void setAuthorRole(String authorRole)
```
    Parameters:
    
    authorRole - the authorRole to set
  - getAuthorSpecialty
```
public String getAuthorSpecialty()
```
    Returns:
    
    the authorSpecialty
  - setAuthorSpecialty
```
public void setAuthorSpecialty(String authorSpecialty)
```
    Parameters:
    
    authorSpecialty - the authorSpecialty to set
  - getClassCode
```
public String getClassCode()
```
    Returns:
    
    the classCode
  - setClassCode
```
public void setClassCode(String classCode)
```
    Parameters:
    
    classCode - the classCode to set
  - setClassCode
```
public void setClassCode(String classCode,
                         boolean setLocalized)
```
    Parameters:
    
    classCode - the classCode to set
    
    setLocalized - whether or not to set the localized field with the same value
  - getClassCode_localized
```
public String getClassCode_localized()
```
    Returns:
    
    the classCode_localized
  - setClassCode_localized
```
public void setClassCode_localized(String classCodeLocalized)
```
    Parameters:
    
    classCodeLocalized - the classCode_localized to set
  - getConfidentialityCode
```
public String getConfidentialityCode()
```
    Returns:
    
    the confidentialityCode
  - setConfidentialityCode
```
public void setConfidentialityCode(String confidentialityCode)
```
    Parameters:
    
    confidentialityCode - the confidentialityCode to set
  - setConfidentialityCode
```
public void setConfidentialityCode(String confidentialityCode,
                                   boolean setLocalized)
```
    Parameters:
    
    confidentialityCode - the confidentialityCode to set
    
    setLocalized - whether or not to set the localized field with the same value
  - getConfidentialityCode_localized
```
public String getConfidentialityCode_localized()
```
    Returns:
    
    the confidentialityCode_localized
  - setConfidentialityCode_localized
```
public void setConfidentialityCode_localized(String confidentialityCodeLocalized)
```
    Parameters:
    
    confidentialityCodeLocalized - the confidentialityCode_localized to set
  - getFormatCode
```
public String getFormatCode()
```
    Returns:
    
    the formatCode
  - setFormatCode
```
public void setFormatCode(String formatCode)
```
    Parameters:
    
    formatCode - the formatCode to set
  - setFormatCode
```
public void setFormatCode(String formatCode,
                          boolean setLocalized)
```
    Parameters:
    
    formatCode - the formatCode to set
    
    setLocalized - whether or not to set the localized field with the same value
  - setFormatCode
```
public void setFormatCode(FormatCodeEnum formatCode)
```
    Parameters:
    
    formatCode - the formatCode to set
  - getFormatCode_localized
```
public String getFormatCode_localized()
```
    Returns:
    
    the formatCode_localized
  - setFormatCode_localized
```
public void setFormatCode_localized(String formatCodeLocalized)
```
    Parameters:
    
    formatCodeLocalized - the formatCode_localized to set
  - getHealthcareFacilityTypeCode
```
public String getHealthcareFacilityTypeCode()
```
    Returns:
    
    the healthcareFacilityTypeCode
  - setHealthcareFacilityTypeCode
```
public void setHealthcareFacilityTypeCode(String healthcareFacilityTypeCode)
```
    Parameters:
    
    healthcareFacilityTypeCode - the healthcareFacilityTypeCode to set
  - setHealthcareFacilityTypeCode
```
public void setHealthcareFacilityTypeCode(String healthcareFacilityTypeCode,
                                          boolean setLocalized)
```
    Parameters:
    
    healthcareFacilityTypeCode - the healthcareFacilityTypeCode to set
    
    setLocalized - whether or not to set the localized field with the same value
  - getHealthcareFacilityTypeCode_localized
```
public String getHealthcareFacilityTypeCode_localized()
```
    Returns:
    
    the healthcareFacilityTypeCode_localized
  - setHealthcareFacilityTypeCode_localized
```
public void setHealthcareFacilityTypeCode_localized(String healthcareFacilityTypeCodeLocalized)
```
    Parameters:
    
    healthcareFacilityTypeCodeLocalized - the healthcareFacilityTypeCode_localized to set
  - getPracticeSettingCode
```
public String getPracticeSettingCode()
```
    Returns:
    
    the practiceSettingCode
  - setPracticeSettingCode
```
public void setPracticeSettingCode(String practiceSettingCode)
```
    Parameters:
    
    practiceSettingCode - the practiceSettingCode to set
  - setPracticeSettingCode
```
public void setPracticeSettingCode(String practiceSettingCode,
                                   boolean setLocalized)
```
    Parameters:
    
    practiceSettingCode - the practiceSettingCode to set
    
    setLocalized - whether or not to set the localized field with the same value
  - getPracticeSettingCode_localized
```
public String getPracticeSettingCode_localized()
```
    Returns:
    
    the practiceSettingCode_localized
  - setPracticeSettingCode_localized
```
public void setPracticeSettingCode_localized(String practiceSettingCodeLocalized)
```
    Parameters:
    
    practiceSettingCodeLocalized - the practiceSettingCode_localized to set
  - getLoinc
```
public String getLoinc()
```
    Returns:
    
    the loinc
  - setLoinc
```
public void setLoinc(String loinc)
```
    Parameters:
    
    loinc - the loinc to set
  - setLoinc
```
public void setLoinc(String loinc,
                     boolean setLocalized)
```
    Parameters:
    
    loinc - the loinc to set
    
    setLocalized - whether or not to set the localized field with the same value
  - getLoinc_localized
```
public String getLoinc_localized()
```
    Returns:
    
    the loinc_localized
  - setLoinc_localized
```
public void setLoinc_localized(String loincLocalized)
```
    Parameters:
    
    loincLocalized - the loinc_localized to set
  - getPatientId
```
public String getPatientId()
```
    Returns:
    
    the patientId
  - setPatientId
```
public void setPatientId(String patientId)
```
    Parameters:
    
    patientId - the patientId to set
  - getUniqueId
```
public String getUniqueId()
```
    Returns:
    
    the uniqueId
  - setUniqueId
```
public void setUniqueId(String uniqueId)
```
    Parameters:
    
    uniqueId - the uniqueId to set
  - getSubmissionSetStatus
```
public String getSubmissionSetStatus()
```
    Returns:
    
    the submissionSetStatus
  - setSubmissionSetStatus
```
public void setSubmissionSetStatus(String submissionSetStatus)
```
    Parameters:
    
    submissionSetStatus - the submissionSetStatus to set
  - getHash
```
public String getHash()
```
    Returns:
    
    the hash
  - setHash
```
public void setHash(String hash)
```
    Parameters:
    
    hash - the hash to set
  - getSize
```
public Long getSize()
```
    Returns:
    
    the size
  - setSize
```
public void setSize(Long size)
```
    Parameters:
    
    size - the size to set
  - getURI
```
public String getURI()
```
    Returns:
    
    the hash
  - setURI
```
public void setURI(String uri)
```
    Parameters:
    
    hash - the hash to set

Class DirectDocument2.Metadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Metadata

Metadata

Method Detail

setValues

toString

getMimeType

setMimeType

getId

setId

getDescription

setDescription

getCreationTime

setCreationTime

getLanguageCode

setLanguageCode

getServiceStartTime

setServiceStartTime

getServiceStopTime

setServiceStopTime

getSourcePatient

setSourcePatient

getAuthorPerson

setAuthorPerson

getAuthorInstitution

setAuthorInstitution

getAuthorRole

setAuthorRole

getAuthorSpecialty

setAuthorSpecialty

getClassCode

setClassCode

setClassCode

getClassCode_localized

setClassCode_localized

getConfidentialityCode

setConfidentialityCode

setConfidentialityCode

getConfidentialityCode_localized

setConfidentialityCode_localized

getFormatCode

setFormatCode

setFormatCode

setFormatCode

getFormatCode_localized

setFormatCode_localized

getHealthcareFacilityTypeCode

setHealthcareFacilityTypeCode

setHealthcareFacilityTypeCode

getHealthcareFacilityTypeCode_localized

setHealthcareFacilityTypeCode_localized

getPracticeSettingCode

setPracticeSettingCode

setPracticeSettingCode

getPracticeSettingCode_localized

setPracticeSettingCode_localized

getLoinc

setLoinc

setLoinc

getLoinc_localized

setLoinc_localized

getPatientId

setPatientId

getUniqueId

setUniqueId

getSubmissionSetStatus

setSubmissionSetStatus

getHash

setHash

getSize

setSize

getURI

setURI