Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.ohf.ihe.xds.metadata.transform
Class EbXML_2_1DocumentEntryTransformer

    java.lang.Object
      org.eclipse.ohf.ihe.xds.metadata.transform.EbXML_2_1DocumentEntryTransformer

All Implemented Interfaces:
  DocumentEntryTransformer

    public class EbXML_2_1DocumentEntryTransformer

extends java.lang.Object
implements DocumentEntryTransformer

Class containing utility methods to transform XDS document entry metadata to ebRIM 2.1 element.

Author:
  Sarah Knoop

Field Summary
`static java.lang.String` | `DESCRIPTOR` Descriptor for Transformer

Constructor Summary
`EbXML_2_1DocumentEntryTransformer()` Creates the transformer.

Method Summary
`AssociationType1` | `getAssociation()` Returns the AssociationType1 containing the document entry metadata values pertinant to the parent document, if present Returns null if the transformation has not been executed, has failed, or no parent exists.
`ExtrinsicObjectType` | `getExtrinsicObject()` Returns the ExtrinsicObjectType containing the document entry metadata values.
`void` | `transform(DocumentEntryType docEntry)` Renders an ExtrinsicObjectType and, if applicable, an AssociationType1 containing the document entry metadata values of the parameter, formatted in ebXML

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

Field Detail

### DESCRIPTOR

    public static final java.lang.String DESCRIPTOR

  Descriptor for Transformer

  See Also:
    Constant Field Values

Constructor Detail

### EbXML_2_1DocumentEntryTransformer

    public EbXML_2_1DocumentEntryTransformer()

  Creates the transformer.

Method Detail

### getExtrinsicObject

    public ExtrinsicObjectType getExtrinsicObject()

  Returns the ExtrinsicObjectType containing the document entry metadata values. Returns null if the transformation has not been executed, or had failed.

  Returns:
    the extrinsic object

### getAssociation

    public AssociationType1 getAssociation()

  Returns the AssociationType1 containing the document entry metadata values pertinant to the parent document, if present Returns null if the transformation has not been executed, has failed, or no parent exists. TODO ... probably should fix the return to be more precise.

  Returns:
    the parent document association, if present

### transform

    public void transform(DocumentEntryType docEntry)
                   throws MetadataTransformationException

  Renders an ExtrinsicObjectType and, if applicable, an AssociationType1 containing the document entry metadata values of the parameter, formatted in ebXML

  Specified by:
    `transform` in interface `DocumentEntryTransformer`
  Throws:
    `MetadataTransformationException`
  See Also:
    `DocumentEntryTransformer.transform(org.eclipse.ohf.ihe.xds.metadata.DocumentEntryType)`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD