com.opentext.ia.sdk.sip

Class XmlPdiAssembler<D>

java.lang.Object

com.opentext.ia.sdk.sip.PrintWriterAssembler<HashedContents<D>>

com.opentext.ia.sdk.sip.PdiAssembler<D>

com.opentext.ia.sdk.sip.XmlPdiAssembler<D>

Type Parameters:

D - The type of domain objects to assemble the XML document from

All Implemented Interfaces:

Assembler<HashedContents<D>>

public abstract class XmlPdiAssembler<D>
extends PdiAssembler<D>

Base class for assembling XML documents from domain objects using an DomXmlBuilder.

Constructor Summary

Constructors

Constructor and Description
XmlPdiAssembler(java.net.URI namespace, java.lang.String domainObjectName) Create an instance.
XmlPdiAssembler(java.net.URI namespace, java.lang.String domainObjectName, java.io.InputStream schema) Create an instance.
XmlPdiAssembler(java.net.URI namespace, java.lang.String documentElementName, java.lang.String domainObjectName) Create an instance.
XmlPdiAssembler(java.net.URI namespace, java.lang.String documentElementName, java.lang.String domainObjectName, java.io.InputStream schema) Create an instance.
XmlPdiAssembler(java.net.URI namespace, java.lang.String documentElementName, java.lang.String domainObjectName, Validator validator) Create an instance.

Method Summary

Modifier and Type	Method and Description
void	add(D domainObject, java.util.Map<java.lang.String,ContentInfo> contentInfo, java.io.PrintWriter writer) Add a domain object.
protected abstract void	doAdd(D domainObject, java.util.Map<java.lang.String,ContentInfo> contentInfo) Add the domain object to the XML document, using getBuilder().
void	end(java.io.PrintWriter writer) End the assembly process.
protected XmlBuilder<java.lang.Void>	getBuilder() Return the XML document builder for capturing a domain object.
void	start(java.io.PrintWriter writer) Start the assembly process.

Methods inherited from class com.opentext.ia.sdk.sip.PdiAssembler

add

Methods inherited from class com.opentext.ia.sdk.sip.PrintWriterAssembler

add, end, getMetrics, start

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlPdiAssembler

public XmlPdiAssembler(java.net.URI namespace,
                       java.lang.String domainObjectName)

Create an instance.

Parameters:

namespace - Optional URI of the XML Namespace to use for the XML document

domainObjectName - The name/tag of the element that captures the domain object. The pluralized version of this will be used for the document element name/tag.

XmlPdiAssembler

public XmlPdiAssembler(java.net.URI namespace,
                       java.lang.String documentElementName,
                       java.lang.String domainObjectName)

Create an instance.

Parameters:

namespace - Optional URI of the XML Namespace to use for the XML document

documentElementName - The name/tag of the document element wrapping the domain objects. This may be null if only one domain object is ever added

domainObjectName - The name/tag of the element that captures the domain object

XmlPdiAssembler

public XmlPdiAssembler(java.net.URI namespace,
                       java.lang.String domainObjectName,
                       java.io.InputStream schema)

Create an instance.

Parameters:

namespace - Optional URI of the XML Namespace to use for the XML document

domainObjectName - The name/tag of the element that captures the domain object

schema - Optional XML Schema for validating the assembled XML document

XmlPdiAssembler

public XmlPdiAssembler(java.net.URI namespace,
                       java.lang.String documentElementName,
                       java.lang.String domainObjectName,
                       java.io.InputStream schema)

Create an instance.

Parameters:

namespace - Optional URI of the XML Namespace to use for the XML document

documentElementName - The name/tag of the document element wrapping the domain objects. This may be null if only one domain object is ever added

domainObjectName - The name/tag of the element that captures the domain object

schema - Optional XML Schema for validating the assembled XML document

XmlPdiAssembler

public XmlPdiAssembler(java.net.URI namespace,
                       java.lang.String documentElementName,
                       java.lang.String domainObjectName,
                       Validator validator)

Create an instance.

Parameters:

namespace - Optional URI of the XML Namespace to use for the XML document

documentElementName - The name/tag of the document element wrapping the domain objects. This may be null if only one domain object is ever added

domainObjectName - The name/tag of the element that captures the domain object

validator - Optional validator for checking whether the XML document meets expectations

Method Detail

getBuilder

protected XmlBuilder<java.lang.Void> getBuilder()

Return the XML document builder for capturing a domain object.

Returns:

The XML document builder for capturing a domain object

doAdd

protected abstract void doAdd(D domainObject,
                              java.util.Map<java.lang.String,ContentInfo> contentInfo)

Add the domain object to the XML document, using getBuilder().

Parameters:

domainObject - The domain object to add

contentInfo - The reference information and the encoded hashed of the content associated with the domain object

start

public void start(java.io.PrintWriter writer)

Description copied from class: PrintWriterAssembler

Start the assembly process.

Specified by:

start in class PrintWriterAssembler<HashedContents<D>>

Parameters:

writer - Where to write output

add

public final void add(D domainObject,
                      java.util.Map<java.lang.String,ContentInfo> contentInfo,
                      java.io.PrintWriter writer)

Description copied from class: PdiAssembler

Add a domain object.

Specified by:

add in class PdiAssembler<D>

Parameters:

domainObject - The domain object to add

contentInfo - The reference information and the encoded hashes of the content associated with the domain object

writer - The writer to print the PDI fragment to

end

public final void end(java.io.PrintWriter writer)

Description copied from class: PrintWriterAssembler

End the assembly process.

Specified by:

end in class PrintWriterAssembler<HashedContents<D>>

Parameters:

writer - Where to write output