com.xml_project.morganaxproc
Class XProcResult

java.lang.Object
  extended by com.xml_project.morganaxproc.XProcResult

public class XProcResult
extends Object

This class acts as a container for the document (sequence) found on an output port.

Subclass XProcResult to get the results from pipeline execution in an other form.


Method Summary
 nu.xom.Document[] getDocuments()
           Return the documents in this XProcResult as a (possibly empty) document array.
 String[] getDocumentsSerialized()
           Results a (possibly empty) string array with the serialized version of the documents in this XProcResult.
 int getNumberOfDocuments()
           Returns the number of documents in this XProcResult.
 String getPortEncoding()
           Returns the encoding option set for this port.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getNumberOfDocuments

public int getNumberOfDocuments()

Returns the number of documents in this XProcResult.

Returns:
the number of documents.

getDocuments

public nu.xom.Document[] getDocuments()

Return the documents in this XProcResult as a (possibly empty) document array.

Returns:
the documents.

getDocumentsSerialized

public String[] getDocumentsSerialized()

Results a (possibly empty) string array with the serialized version of the documents in this XProcResult.

The serialization is performed according to the p:serialization defined for the output port in the XProc pipeline from which the XProcResult was obtained. If no p:serialization is provided for the port, the default settings are used.

Returns:
a string array with the serialized documents.

getPortEncoding

public String getPortEncoding()

Returns the encoding option set for this port.

Returns:
the encoding for this port.