Package de.uni_trier.wi2.procake.data.io.xml.xerces_saxImpl

Class ObjectHandler

java.lang.Object

de.uni_trier.wi2.procake.utils.composition.FactoryObjectImplementation

de.uni_trier.wi2.procake.data.io.IOImpl

de.uni_trier.wi2.procake.data.io.xml.xerces_saxImpl.XMLReadHandlerImpl

de.uni_trier.wi2.procake.data.io.xml.xerces_saxImpl.ObjectHandler

All Implemented Interfaces:

ObjectTags, ContentHandler, IO, ContentHandler

public class ObjectHandler
extends XMLReadHandlerImpl
implements ObjectTags

ObjectHandler class.

Author:

Rainer Maximini

Field Summary

Fields

Modifier and Type	Field	Description
static String	HANDLERNAME	Constant HANDLERNAME="DataObjectContentHandler"

Fields inherited from interface de.uni_trier.wi2.procake.utils.io.IO

COMPONENT, COMPONENT_KEY, DEFAULT_ENCODING, LOG_CONTENTHANDLER_NOT_FOUND, LOG_FILE_NOT_FOUND, LOG_IO_EXCEPTION, LOG_READER_NOT_FOUND, LOG_SAX_EXCEPTION, LOG_UNKNOWN_PARAMETER, LOG_WRITER_NOT_FOUND, LOG_WRONG_PARAMATER_TYPE, RESOURCE_XML

Fields inherited from interface de.uni_trier.wi2.procake.data.io.xml.ObjectTags

ATT_CLASS, ATT_ID, ATT_NAME, ATT_VALUE, PREFIX_CDOL, SCHEMA_LOCATION_CDOL, TAG_AGGREGATE, TAG_ATOMIC, TAG_ATOMICATTRIBUTE, TAG_ATTRIBUTE, TAG_ATTRIBUTEPATH, TAG_BYTEARRAY, TAG_BYTEARRAYCONTENT, TAG_COLLECTION, TAG_INTERVAL, TAG_INTERVAL_LOWER_BOUND, TAG_INTERVAL_UPPER_BOUND, TAG_OBJECT_ATTRIBUTE, TAG_PROPERTY, TAG_QUERY, TAG_VOID, TAG_VOID_ATTRIBUTE, URI_CDOL

Constructor Summary

Constructors

Constructor	Description
ObjectHandler()	Constructor for ObjectHandler.

Method Summary

Modifier and Type	Method	Description
protected void	addID(DataObject dataObject, Attributes attributes)	addID.
IO	copy()	overwritten copy-method from Object; use it to copy a complete operator
DataObject	createNewObject(String className, String attributeName)	Creates a new CAKEI-dataobject with the given classname OR based on the type of the given attribute.
DataObject	createNewObject(Attributes attributes)	Creates a new CAKEI-dataobject with the given SAX-parser Tag-attributes
void	endElement(String uri, String localName, String qName)
protected void	endElementAtomicAttribute()	endElementAtomicAttribute.
protected void	endElementByteArrayContent()	endElementByteArrayContent.
protected void	endElementObjectAttribute()	endElementObjectAttribute.
protected void	endElementProperty()	endElementProperty.
protected void	endElementVoidAttribute()	endElementVoidAttribute.
boolean	existParentObject()	existParentObject.
protected void	finishObject()	finishObject.
String	getDescription()	A description of the io component.
String	getName()	Each io component must have a name that is used in IOFactory.newIO(String).
Object	getObject()	After parsing the document, this method must be called to get the Object.
boolean	isHandlerFor(Class value)	Checks if the io component is capable to perform the operation for objects of this class.
boolean	isHandlerFor(String uri, String localName, String qName, Attributes attributes)	Queries the handler for possible handling of the given (SAX-)parameters
boolean	isIgnoreUnknownAttributes()	isIgnoreUnknownAttributes.
void	setIgnoreUnknownAttributes(boolean ignoreAttributes)	Setter for the field ignoreUnknownAttributes.
void	startElement(String uri, String localName, String qName, Attributes attributes)
protected void	startElementAtomic(Attributes attributes)	startElementAtomic.
protected void	startElementAtomicAttribute(Attributes attributes)	startElementAtomicAttribute.
protected void	startElementAttribute(Attributes attributes)	startElementAttribute.
protected void	startElementAttributePath(Attributes attributes)	startElementAttributePath.
protected void	startElementByteArrayContent(Attributes attributes)	startElementByteArrayContent.
protected void	startElementIntervalAttribute(Attributes attributes)	startElementIntervalAttribute.
protected void	startElementObjectAttribute(Attributes attributes)	startElementObjectAttribute.
protected void	startElementProperty(Attributes attributes)	startElementProperty.
protected void	startElementVoidAttribute(Attributes attributes)	startElementVoidAttribute.
void	subHandlerFinishedWithObject(Object subHandlerObject)	Callback-method from the subHandler to inform the parentHandler about the finished object

Methods inherited from class de.uni_trier.wi2.procake.data.io.xml.xerces_saxImpl.XMLReadHandlerImpl

callSubHandlerEnd, callSubHandlerStart, characters, endDocument, endPrefixMapping, getCharacterString, getDocumentLocator, ignorableWhitespace, initiateSubHandler, notifyParentHandler, processingInstruction, resetSubHandler, setCharacterString, setDocumentLocator, setParentHandler, skippedEntity, startDocument, startPrefixMapping

Methods inherited from class de.uni_trier.wi2.procake.data.io.IOImpl

getFamily, getParameters, postInit, preInit, setFamily

Methods inherited from class de.uni_trier.wi2.procake.utils.composition.FactoryObjectImplementation

getParameter, initParametersBasedOn

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.uni_trier.wi2.procake.utils.io.IO

getFamily, setFamily

Field Detail

HANDLERNAME

public static final String HANDLERNAME

Constant HANDLERNAME="DataObjectContentHandler"

See Also:

Constant Field Values

Constructor Detail

ObjectHandler

public ObjectHandler()

Constructor for ObjectHandler.

Method Detail

getDescription

public String getDescription()

A description of the io component. The description should contain the file format and the classes that can be managed.

Specified by:

getDescription in interface IO

Overrides:

getDescription in class IOImpl

Returns:

a description of the io component

getName

public String getName()

Each io component must have a name that is used in IOFactory.newIO(String). The name must be unique thus it is usefull to use a short description or to the class name ( this.getClass().getName()).

Specified by:

getName in interface IO

Returns:

Returns the name of the io component.

getObject

public Object getObject()

After parsing the document, this method must be called to get the Object. This method can only be called once, because after calling the internal variables are resetted to reuse the object.

Specified by:

getObject in interface ContentHandler

isHandlerFor

public boolean isHandlerFor(String uri,
                            String localName,
                            String qName,
                            Attributes attributes)

Queries the handler for possible handling of the given (SAX-)parameters

Specified by:

isHandlerFor in interface ContentHandler

Returns:

isHandlerFor

public boolean isHandlerFor(Class value)

Checks if the io component is capable to perform the operation for objects of this class.

A typical implementation looks like:

 public boolean isHandlerFor(Class value) {
        if (DataObject.class.isAssignableFrom(value))
                return true;
        return false;
 }
 

Specified by:

isHandlerFor in interface IO

Parameters:

value - The class that has to be checked.

Returns:

Results true if the class can oeprate with the given class.

copy

public IO copy()

overwritten copy-method from Object; use it to copy a complete operator

Specified by:

copy in interface IO

Returns:

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes attributes)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Throws:

SAXException

endElement

public void endElement(String uri,
                       String localName,
                       String qName)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Throws:

SAXException

createNewObject

public DataObject createNewObject(String className,
                                  String attributeName)
                           throws ClassNotFoundException,
                                  IllegalInstantiationException,
                                  InvalidTypeException,
                                  NoSuchAttributeException

Creates a new CAKEI-dataobject with the given classname OR based on the type of the given attribute. One of the parameters is only used.

Parameters:

className - Name of the CAKEI-class, which should be instantiated; can be null

attributeName - Name of the attribute of the parent-Aggregrate-class, from which the type should be used to instantiate a new object; can be null

Returns:

instantiated CAKE1-object.

Throws:

ClassNotFoundException - if any.

IllegalInstantiationException - if any.

InvalidTypeException - if any.

NoSuchAttributeException - if any.

createNewObject

public DataObject createNewObject(Attributes attributes)
                           throws ClassNotFoundException,
                                  IllegalInstantiationException,
                                  InvalidTypeException,
                                  NoSuchAttributeException

Creates a new CAKEI-dataobject with the given SAX-parser Tag-attributes

Parameters:

attributes - The attributes either contain "c=" with defining the CAKE1class, which should be instantiated OR contains the "n=", which defines the name of the attribute from the parent-aggregate, to instantiate a CAKE1-Object by the attributes' type

Returns:

a DataObject object

Throws:

ClassNotFoundException - if any.

IllegalInstantiationException - if any.

InvalidTypeException - if any.

NoSuchAttributeException - if any.

endElementAtomicAttribute

protected void endElementAtomicAttribute()
                                  throws InvalidNativeValueException,
                                         InvalidTypeException

endElementAtomicAttribute.

Throws:

InvalidNativeValueException - if any.

InvalidTypeException - if any.

endElementVoidAttribute

protected void endElementVoidAttribute()

endElementVoidAttribute.

endElementByteArrayContent

protected void endElementByteArrayContent()
                                   throws InvalidNativeValueException,
                                          InvalidTypeException,
                                          SAXException

endElementByteArrayContent.

Throws:

InvalidNativeValueException - if any.

InvalidTypeException - if any.

SAXException - if any.

endElementObjectAttribute

protected void endElementObjectAttribute()

endElementObjectAttribute.

endElementProperty

protected void endElementProperty()
                           throws SAXException,
                                  NoSuchAttributeException

endElementProperty.

Throws:

SAXException - if any.

NoSuchAttributeException - if any.

existParentObject

public boolean existParentObject()

existParentObject.

Returns:

a boolean

finishObject

protected void finishObject()
                     throws InvalidTypeException,
                            SAXException

finishObject.

Throws:

InvalidTypeException - if any.

SAXException - if any.

isIgnoreUnknownAttributes

public boolean isIgnoreUnknownAttributes()

isIgnoreUnknownAttributes.

Returns:

a boolean

setIgnoreUnknownAttributes

public void setIgnoreUnknownAttributes(boolean ignoreAttributes)

Setter for the field ignoreUnknownAttributes.

Parameters:

ignoreAttributes - a boolean

startElementAtomic

protected void startElementAtomic(Attributes attributes)
                           throws InvalidNativeValueException,
                                  ClassNotFoundException,
                                  IllegalInstantiationException,
                                  InvalidTypeException,
                                  NoSuchAttributeException

startElementAtomic.

Parameters:

attributes - a Attributes object

Throws:

InvalidNativeValueException - if any.

ClassNotFoundException - if any.

IllegalInstantiationException - if any.

InvalidTypeException - if any.

NoSuchAttributeException - if any.

startElementAtomicAttribute

protected void startElementAtomicAttribute(Attributes attributes)
                                    throws InvalidNativeValueException,
                                           ClassNotFoundException,
                                           IllegalInstantiationException,
                                           InvalidTypeException,
                                           NoSuchAttributeException

startElementAtomicAttribute.

Parameters:

attributes - a Attributes object

Throws:

InvalidNativeValueException - if any.

ClassNotFoundException - if any.

IllegalInstantiationException - if any.

InvalidTypeException - if any.

NoSuchAttributeException - if any.

startElementIntervalAttribute

protected void startElementIntervalAttribute(Attributes attributes)

startElementIntervalAttribute.

Parameters:

attributes - a Attributes object

startElementVoidAttribute

protected void startElementVoidAttribute(Attributes attributes)
                                  throws ClassNotFoundException,
                                         IllegalInstantiationException,
                                         InvalidTypeException,
                                         NoSuchAttributeException

startElementVoidAttribute.

Parameters:

attributes - a Attributes object

Throws:

ClassNotFoundException - if any.

IllegalInstantiationException - if any.

InvalidTypeException - if any.

NoSuchAttributeException - if any.

startElementAttribute

protected void startElementAttribute(Attributes attributes)

startElementAttribute.

Parameters:

attributes - a Attributes object

startElementAttributePath

protected void startElementAttributePath(Attributes attributes)

startElementAttributePath.

Parameters:

attributes - a Attributes object

startElementByteArrayContent

protected void startElementByteArrayContent(Attributes attributes)
                                     throws InvalidNativeValueException,
                                            ClassNotFoundException,
                                            IllegalInstantiationException,
                                            InvalidTypeException,
                                            NoSuchAttributeException

startElementByteArrayContent.

Parameters:

attributes - a Attributes object

Throws:

InvalidNativeValueException - if any.

ClassNotFoundException - if any.

IllegalInstantiationException - if any.

InvalidTypeException - if any.

NoSuchAttributeException - if any.

startElementObjectAttribute

protected void startElementObjectAttribute(Attributes attributes)
                                    throws ClassNotFoundException,
                                           IllegalInstantiationException,
                                           InvalidTypeException,
                                           NoSuchAttributeException

startElementObjectAttribute.

Parameters:

attributes - a Attributes object

Throws:

ClassNotFoundException - if any.

IllegalInstantiationException - if any.

InvalidTypeException - if any.

NoSuchAttributeException - if any.

startElementProperty

protected void startElementProperty(Attributes attributes)

startElementProperty.

Parameters:

attributes - a Attributes object

addID

protected void addID(DataObject dataObject,
                     Attributes attributes)

addID.

Parameters:

dataObject - a DataObject object

attributes - a Attributes object

subHandlerFinishedWithObject

public void subHandlerFinishedWithObject(Object subHandlerObject)

Callback-method from the subHandler to inform the parentHandler about the finished object

Specified by:

subHandlerFinishedWithObject in interface ContentHandler

Specified by:

subHandlerFinishedWithObject in class XMLReadHandlerImpl

Parameters:

subHandlerObject - The object created by the subHandler.