com.vordel.es.xes

Class PortableESPKFactory

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.vordel.es.xes.XMLParser

com.vordel.es.xes.PortableESPKFactory

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class PortableESPKFactory
extends XMLParser

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PortableESPKFactory.PortableESPKHandler

Field Summary

Fields inherited from class com.vordel.es.xes.XMLParser

handlers

Method Summary

Modifier and Type	Method and Description
java.lang.String	convertESPKToXML(EntityStore es, ESPK pk) Convenience method to return the portable version of the ESPK as an XML fragment.
PortableESPK	createPortableESPK(byte[] xmlKeyFragment)
PortableESPK	createPortableESPK(org.w3c.dom.Element node) Include a DOM-based factory method for creating PortableESPKs, for parsers which themselves use DOM rather than SAX.
PortableESPK	createPortableESPK(Entity e) Create the portable ESPK for a new, freshly decoded entity.
PortableESPK	createPortableESPK(EntityStore es, ESPK pk) Method to get the portable key version of a specific Entity in a specific EntityStore.
PortableESPK	createPortableESPK(java.lang.String xmlKeyFragment)
static PortableESPKFactory	newInstance()

Methods inherited from class com.vordel.es.xes.XMLParser

characters, endElement, parse, registerHandler, startElement

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static PortableESPKFactory newInstance()

createPortableESPK

public final PortableESPK createPortableESPK(byte[] xmlKeyFragment)

createPortableESPK

public final PortableESPK createPortableESPK(java.lang.String xmlKeyFragment)

createPortableESPK

public final PortableESPK createPortableESPK(org.w3c.dom.Element node)

Include a DOM-based factory method for creating PortableESPKs, for parsers which themselves use DOM rather than SAX.

Parameters:

node - The starting Element of a PPK.

Returns:

A PortableESPK, deserialized from the DOM objects, or null if the Elements don't describe a key.

createPortableESPK

public PortableESPK createPortableESPK(Entity e)
                                throws EntityStoreException

Create the portable ESPK for a new, freshly decoded entity. This portablePK will be extended to include the context of the parent portable PK, should it be specified.

Parameters:

e - The Entity, which should have an ESPK attached.

Returns:

A PortableESPK representing this Entity.

Throws:

EntityStoreException

createPortableESPK

public PortableESPK createPortableESPK(EntityStore es,
                                       ESPK pk)

Method to get the portable key version of a specific Entity in a specific EntityStore.

Parameters:

es - The EntityStore from which to generate the portable key.

pk - The key of the Entity to translate to a portable form.

Returns:

A PortableESPK representing the Entity identified by the PK in a store-neutral format.

convertESPKToXML

public java.lang.String convertESPKToXML(EntityStore es,
                                         ESPK pk)

Convenience method to return the portable version of the ESPK as an XML fragment.

Parameters:

es - The EntityStore containing the Entity specified

pk - The ESPK of the Entity whose location is to be described. Must be non-null and not the NULL_ESPK.

Returns:

A String representation of the portable ESPK, or an empty String if there was a problem in generating the XML.