org.cristalise.kernel.persistency.outcome

Class Outcome

java.lang.Object

org.cristalise.kernel.persistency.outcome.Outcome

All Implemented Interfaces:

C2KLocalObject

public class Outcome
extends Object
implements C2KLocalObject

A C2KLocalObject encapsulating management of XML data. It has methods to manipulate and validate the XML, and with a valid ID it can be stored in ClusterStore.

Constructor Summary

Constructors

Constructor and Description
Outcome(int id, Document dom, Schema schema) Very basic constructor to set all members
Outcome(int id, String xml, Schema schema) Use this constructor to manipulate, validate and store this outcome
Outcome(String xml) Use this constructor for XML manipulation only.
Outcome(String path, Document data) The constructor derives all the meta data (ID and Schema) from the path
Outcome(String xml, Schema schema) Use this constructor for XML manipulation and validation.
Outcome(String path, String xml) The constructor derives all the meta data (ID and Schema) from the path

Method Summary

Modifier and Type	Method and Description
Node	appendXmlFragment(String xpath, String xmlFragment) Append the new Node created from xmlFragment as a child of the Node selected by the XPath
String	getAttribute(String name) Retrieves an Attribute value by name of the root Element.
String	getAttributeOfField(String field, String attribute) Retrieves an Attribute value by name from the named Element.
String	getClusterPath() Each C2KLocalObject is stored with a path identifier starting with the ClusterType: Properties: /Property/Name Workflow: /LifeCycle/workflow Collections: /Collection/Name/Version (default Name='last') Outcomes: /Outcome/SchemaName/SchemaVersion/EventID Viewpoints: /ViewPoint/SchemaName/Name (default Name='last') Events: /AuditTrail/EventID Jobs: /Job/JobID
String	getClusterType() Each object belongs to a specific type defined in ClusterStorage
String	getData()
String	getField(String name) Retrieves the textNode value of the named Element of the root Element.
String	getFieldByXPath(String xpath) Retrieves the text, CDATA or attribute value of the Node selected by the XPath
String	getName() Gets the name of the C2KLocalObject
Node	getNodeByXPath(String xpathExpr)
NodeList	getNodesByXPath(String xpathExpr)
String	getSchemaType() Deprecated.
int	getSchemaVersion() Deprecated.
static Document	parse(String xml) Parses the outcome into a DOM tree
Node	removeNodeByXPath(String xpathExpr)
static String	serialize(Document doc, boolean prettyPrint)
void	setData(String xml)
void	setFieldByXPath(String xpath, String data) Sets the text, CDATA or attribute value of the Node selected by the XPath.
void	setFieldByXPath(String xpath, String data, boolean remove) Sets the text, CDATA or attribute value of the Node selected by the XPath.
protected void	setMetaDataFromPath(String path)
void	setName(String name) Sets the name of the C2KLocalObject
String	validate() Validates the actual XML Document against the provided Schema
void	validateAndCheck() Validates the actual XML Document against the provided Schema

Methods inherited from class java.lang.Object

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

Constructor Detail

Outcome

public Outcome(String xml)
        throws InvalidDataException

Use this constructor for XML manipulation only. This Outcome cannot be validate not it can be stored in ClusterStore.

Parameters:

xml - the XML string to be manipulated

Throws:

InvalidDataException - there was an error parsing the XML

Outcome

public Outcome(String xml,
               Schema schema)
        throws InvalidDataException

Use this constructor for XML manipulation and validation. This Outcome cannot be stored in ClusterStore.

Parameters:

xml - the XML string to be manipulated

schema - the Schema of the XML

Throws:

InvalidDataException - there was an error parsing the XML

Outcome

public Outcome(int id,
               String xml,
               Schema schema)
        throws InvalidDataException

Use this constructor to manipulate, validate and store this outcome

Parameters:

id - eventID

xml - the XML string to be manipulated

schema - the Schema of the XML

Throws:

InvalidDataException - there was an error parsing the XML

Outcome

public Outcome(int id,
               Document dom,
               Schema schema)

Very basic constructor to set all members

Parameters:

id - eventID

dom - parsed XML Document

schema - the Schema instance

Outcome

public Outcome(String path,
               String xml)
        throws PersistencyException,
               InvalidDataException

The constructor derives all the meta data (ID and Schema) from the path

Parameters:

path - the actuals path used by the ClusterStorage

xml - the XML string to parse

Throws:

PersistencyException - there was DB error

InvalidDataException - Version or EventID was an invalid number

Outcome

public Outcome(String path,
               Document data)
        throws PersistencyException,
               InvalidDataException

The constructor derives all the meta data (ID and Schema) from the path

Parameters:

path - the actuals path used by the ClusterStorage

data - the parsed xml Document

Throws:

PersistencyException - there was DB error

InvalidDataException - Version or EventID was an invalid number

Method Detail

setMetaDataFromPath

protected void setMetaDataFromPath(String path)
                            throws PersistencyException,
                                   InvalidDataException

Throws:

PersistencyException

InvalidDataException

validate

public String validate()
                throws InvalidDataException

Validates the actual XML Document against the provided Schema

Returns:

the errors found

Throws:

InvalidDataException - Schema was null

validateAndCheck

public void validateAndCheck()
                      throws InvalidDataException

Validates the actual XML Document against the provided Schema

Throws:

InvalidDataException - XML document is not valid instance of the Schema

setName

public void setName(String name)

Description copied from interface: C2KLocalObject

Sets the name of the C2KLocalObject

Specified by:

setName in interface C2KLocalObject

Parameters:

name - Name of the C2KLocalObject

getName

public String getName()

Description copied from interface: C2KLocalObject

Gets the name of the C2KLocalObject

Specified by:

getName in interface C2KLocalObject

Returns:

name of the C2KLocalObject

setData

public void setData(String xml)
             throws SAXException,
                    IOException

Throws:

SAXException

IOException

getFieldByXPath

public String getFieldByXPath(String xpath)
                       throws XPathExpressionException,
                              InvalidDataException

Retrieves the text, CDATA or attribute value of the Node selected by the XPath

Parameters:

xpath - The path to access the selected Node

Returns:

the value of the selected Node

Throws:

XPathExpressionException - xpath was not valid (e.g. there is no such node)

InvalidDataException - xpath result is not text, CDATA or attribute

setFieldByXPath

public void setFieldByXPath(String xpath,
                            String data)
                     throws XPathExpressionException,
                            InvalidDataException

Sets the text, CDATA or attribute value of the Node selected by the XPath. It only updates existing Nodes.

Parameters:

xpath - the selected Node to be updated

data - string containing the data

Throws:

XPathExpressionException - xpath is invalid

InvalidDataException - xpath result is not text, CDATA or attribute

setFieldByXPath

public void setFieldByXPath(String xpath,
                            String data,
                            boolean remove)
                     throws XPathExpressionException,
                            InvalidDataException

Sets the text, CDATA or attribute value of the Node selected by the XPath. It only updates existing Nodes. If data is null and the node exists, the node is removed

Parameters:

xpath - the selected Node to be updated

data - string containing the data, it can be null

remove - flag to remove existing node when data is null

Throws:

XPathExpressionException - xpath is invalid

InvalidDataException - xpath result is not text, CDATA or attribute

appendXmlFragment

public Node appendXmlFragment(String xpath,
                              String xmlFragment)
                       throws InvalidDataException

Append the new Node created from xmlFragment as a child of the Node selected by the XPath

Parameters:

xpath - the selected parent node

xmlFragment - string containing the xml fragment

Returns:

the Node just added

Throws:

InvalidDataException

getData

public String getData()

getSchemaType

@Deprecated
public String getSchemaType()

Deprecated.

getSchemaVersion

@Deprecated
public int getSchemaVersion()

Deprecated.

getClusterType

public String getClusterType()

Description copied from interface: C2KLocalObject

Each object belongs to a specific type defined in ClusterStorage

Specified by:

getClusterType in interface C2KLocalObject

Returns:

string id of the type

getClusterPath

public String getClusterPath()

Description copied from interface: C2KLocalObject

Each C2KLocalObject is stored with a path identifier starting with the ClusterType:

• Properties: /Property/Name
• Workflow: /LifeCycle/workflow
• Collections: /Collection/Name/Version (default Name='last')
• Outcomes: /Outcome/SchemaName/SchemaVersion/EventID
• Viewpoints: /ViewPoint/SchemaName/Name (default Name='last')
• Events: /AuditTrail/EventID
• Jobs: /Job/JobID

Specified by:

getClusterPath in interface C2KLocalObject

Returns:

The path identifier (i.e. primary key) of the object

parse

public static Document parse(String xml)
                      throws SAXException,
                             IOException

Parses the outcome into a DOM tree

Parameters:

xml - string to be parsed

Returns:

the parsed Document

Throws:

SAXException - error parsing document

IOException - any IO errors occur

getAttribute

public String getAttribute(String name)

Retrieves an Attribute value by name of the root Element.

Parameters:

name - The name of the attribute to retrieve.

Returns:

The value as a string, or null if that attribute does not have a specified or default value.

getAttributeOfField

public String getAttributeOfField(String field,
                                  String attribute)

Retrieves an Attribute value by name from the named Element.

Parameters:

field - The name of the field.

attribute - The name of the attribute to retrieve.

Returns:

The value as a string, or null if that attribute does not have a specified or default value.

getField

public String getField(String name)

Retrieves the textNode value of the named Element of the root Element.

Parameters:

name - The name of the Element

Returns:

The value as a string, or null if that field does not exists

getNodesByXPath

public NodeList getNodesByXPath(String xpathExpr)
                         throws XPathExpressionException

Throws:

XPathExpressionException

getNodeByXPath

public Node getNodeByXPath(String xpathExpr)
                    throws XPathExpressionException

Throws:

XPathExpressionException

removeNodeByXPath

public Node removeNodeByXPath(String xpathExpr)
                       throws XPathExpressionException,
                              InvalidDataException

Throws:

XPathExpressionException

InvalidDataException

serialize

public static String serialize(Document doc,
                               boolean prettyPrint)
                        throws InvalidDataException

Throws:

InvalidDataException