Package org.openehealth.ipf.commons.ihe.xds.core.ebxml.ebxml30

Class EbXMLFactory30

java.lang.Object

org.openehealth.ipf.commons.ihe.xds.core.ebxml.ebxml30.EbXMLFactory30

All Implemented Interfaces:

EbXMLFactory

public class EbXMLFactory30
extends Object
implements EbXMLFactory

Factory for EbXML 3.0 objects.

Author:

Jens Riemschneider

Field Summary

Fields

Modifier and Type	Field	Description
static final ObjectFactory	LCM_FACTORY	The factory to create objects of the lcm namespace.
static final ObjectFactory	QUERY_FACTORY	The factory to create objects of the query namespace.
static final ObjectFactory	RIM_FACTORY	The factory to create objects of the rim namespace.
static final ObjectFactory	RS_FACTORY	The factory to create objects of the rs namespace.

Constructor Summary

Constructors

Constructor	Description
EbXMLFactory30()

Method Summary

Modifier and Type	Method	Description
EbXMLAdhocQueryRequest<AdhocQueryRequest>	createAdhocQueryRequest()	Creates a new request to query a registry.
EbXMLQueryResponse<AdhocQueryResponse>	createAdhocQueryResponse(EbXMLObjectLibrary objectLibrary, boolean returnsObjectRefs)	Creates a new response for a query request.
EbXMLAssociation	createAssociation(String id, EbXMLObjectLibrary objectLibrary)	Creates a new association.
EbXMLClassification	createClassification(EbXMLObjectLibrary objectLibrary)	Creates a new classification.
EbXMLExtrinsicObject	createExtrinsic(String id, EbXMLObjectLibrary objectLibrary)	Creates a new extrinsic object and adds it to the object library.
EbXMLObjectLibrary	createObjectLibrary()
EbXMLProvideAndRegisterDocumentSetRequest<ProvideAndRegisterDocumentSetRequestType>	createProvideAndRegisterDocumentSetRequest(EbXMLObjectLibrary objectLibrary)	Creates a new request to provide and register documents.
EbXMLRegistryError	createRegistryError()	Creates a new registry error object.
EbXMLRegistryPackage	createRegistryPackage(String id, EbXMLObjectLibrary objectLibrary)	Creates a new registry package and adds it to the object library.
EbXMLRegistryResponse<RegistryResponseType>	createRegistryResponse()	Creates a new response for a registry request.
EbXMLNonconstructiveDocumentSetRequest<RemoveDocumentsRequestType>	createRemoveDocumentsRequest()	Creates a new request to remove documents.
EbXMLRemoveMetadataRequest<RemoveObjectsRequest>	createRemoveMetadataRequest()	Creates a new remove metadata request.
EbXMLNonconstructiveDocumentSetRequest<RetrieveDocumentSetRequestType>	createRetrieveDocumentSetRequest()	Creates a new request to retrieve documents.
EbXMLRetrieveDocumentSetResponse<RetrieveDocumentSetResponseType>	createRetrieveDocumentSetResponse()	Creates a new response for a retrieve document request.
EbXMLRetrieveImagingDocumentSetRequest<RetrieveImagingDocumentSetRequestType>	createRetrieveImagingDocumentSetRequest()	Creates a new request to retrieve imaging documents.
EbXMLSubmitObjectsRequest<SubmitObjectsRequest>	createSubmitObjectsRequest()	Creates a new request to submit objects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

QUERY_FACTORY

public static final ObjectFactory QUERY_FACTORY

The factory to create objects of the query namespace.

RIM_FACTORY

public static final ObjectFactory RIM_FACTORY

The factory to create objects of the rim namespace.

RS_FACTORY

public static final ObjectFactory RS_FACTORY

The factory to create objects of the rs namespace.

LCM_FACTORY

public static final ObjectFactory LCM_FACTORY

The factory to create objects of the lcm namespace.

Constructor Details

EbXMLFactory30

public EbXMLFactory30()

Method Details

createClassification

public EbXMLClassification createClassification(EbXMLObjectLibrary objectLibrary)

Description copied from interface: EbXMLFactory

Creates a new classification.

Specified by:

createClassification in interface EbXMLFactory

Parameters:

objectLibrary - the object library to use.

Returns:

the created object.

createExtrinsic

public EbXMLExtrinsicObject createExtrinsic(String id,
 EbXMLObjectLibrary objectLibrary)

Description copied from interface: EbXMLFactory

Creates a new extrinsic object and adds it to the object library.

Specified by:

createExtrinsic in interface EbXMLFactory

Parameters:

id - the id of the object within the object library.

objectLibrary - the object library to use.

Returns:

the created object.

createRegistryPackage

public EbXMLRegistryPackage createRegistryPackage(String id,
 EbXMLObjectLibrary objectLibrary)

Description copied from interface: EbXMLFactory

Creates a new registry package and adds it to the object library.

Specified by:

createRegistryPackage in interface EbXMLFactory

Parameters:

id - the id of the object within the object library.

objectLibrary - the object library to use.

Returns:

the created object.

createAssociation

public EbXMLAssociation createAssociation(String id,
 EbXMLObjectLibrary objectLibrary)

Description copied from interface: EbXMLFactory

Creates a new association.

Specified by:

createAssociation in interface EbXMLFactory

Parameters:

id - the id of the object within the object library.

objectLibrary - the object library to use.

Returns:

the created object.

createSubmitObjectsRequest

public EbXMLSubmitObjectsRequest<SubmitObjectsRequest> createSubmitObjectsRequest()

Description copied from interface: EbXMLFactory

Creates a new request to submit objects.

Specified by:

createSubmitObjectsRequest in interface EbXMLFactory

Returns:

the created object.

createProvideAndRegisterDocumentSetRequest

public EbXMLProvideAndRegisterDocumentSetRequest<ProvideAndRegisterDocumentSetRequestType> createProvideAndRegisterDocumentSetRequest(EbXMLObjectLibrary objectLibrary)

Description copied from interface: EbXMLFactory

Creates a new request to provide and register documents.

Specified by:

createProvideAndRegisterDocumentSetRequest in interface EbXMLFactory

Parameters:

objectLibrary - the object library to use.

Returns:

the created object.

createRetrieveDocumentSetRequest

public EbXMLNonconstructiveDocumentSetRequest<RetrieveDocumentSetRequestType> createRetrieveDocumentSetRequest()

Description copied from interface: EbXMLFactory

Creates a new request to retrieve documents.

Specified by:

createRetrieveDocumentSetRequest in interface EbXMLFactory

Returns:

the created object.

createRemoveDocumentsRequest

public EbXMLNonconstructiveDocumentSetRequest<RemoveDocumentsRequestType> createRemoveDocumentsRequest()

Description copied from interface: EbXMLFactory

Creates a new request to remove documents.

Specified by:

createRemoveDocumentsRequest in interface EbXMLFactory

Returns:

the created object.

createRetrieveImagingDocumentSetRequest

public EbXMLRetrieveImagingDocumentSetRequest<RetrieveImagingDocumentSetRequestType> createRetrieveImagingDocumentSetRequest()

Description copied from interface: EbXMLFactory

Creates a new request to retrieve imaging documents.

Specified by:

createRetrieveImagingDocumentSetRequest in interface EbXMLFactory

Returns:

the created object.

createObjectLibrary

public EbXMLObjectLibrary createObjectLibrary()

Specified by:

createObjectLibrary in interface EbXMLFactory

Returns:

a new instance of an object library filled with object references used for ebXML requests/responses.

createRegistryResponse

public EbXMLRegistryResponse<RegistryResponseType> createRegistryResponse()

Description copied from interface: EbXMLFactory

Creates a new response for a registry request.

Specified by:

createRegistryResponse in interface EbXMLFactory

Returns:

the created object.

createRetrieveDocumentSetResponse

public EbXMLRetrieveDocumentSetResponse<RetrieveDocumentSetResponseType> createRetrieveDocumentSetResponse()

Description copied from interface: EbXMLFactory

Creates a new response for a retrieve document request.

Specified by:

createRetrieveDocumentSetResponse in interface EbXMLFactory

Returns:

the created object.

createAdhocQueryRequest

public EbXMLAdhocQueryRequest<AdhocQueryRequest> createAdhocQueryRequest()

Description copied from interface: EbXMLFactory

Creates a new request to query a registry.

Specified by:

createAdhocQueryRequest in interface EbXMLFactory

Returns:

the created object.

createAdhocQueryResponse

public EbXMLQueryResponse<AdhocQueryResponse> createAdhocQueryResponse(EbXMLObjectLibrary objectLibrary,
 boolean returnsObjectRefs)

Description copied from interface: EbXMLFactory

Creates a new response for a query request.

Specified by:

createAdhocQueryResponse in interface EbXMLFactory

Parameters:

objectLibrary - the object library to use.

returnsObjectRefs - true if the response is meant to return object references instead of the real objects. This parameter should be true to ensure that an object library is not included in the query result contains ObjectRefs. Those ObjectRefs cannot be distinguished from the ObjectRefs of the object library and therefore the object library would produce unwanted query results.

Returns:

the created object.

createRegistryError

public EbXMLRegistryError createRegistryError()

Description copied from interface: EbXMLFactory

Creates a new registry error object.

Specified by:

createRegistryError in interface EbXMLFactory

Returns:

the created object.

createRemoveMetadataRequest

public EbXMLRemoveMetadataRequest<RemoveObjectsRequest> createRemoveMetadataRequest()

Description copied from interface: EbXMLFactory

Creates a new remove metadata request.

Specified by:

createRemoveMetadataRequest in interface EbXMLFactory

Returns:

the created object.