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

Class ObjectWriter

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_writerImpl.AbstractXMLWriter

de.uni_trier.wi2.procake.data.io.xml.xerces_writerImpl.ObjectWriter

All Implemented Interfaces:

ObjectTags, IO, ProCAKEWriter

Direct Known Subclasses:

NESTGraphWriter

public class ObjectWriter
extends AbstractXMLWriter
implements ObjectTags

ObjectWriter class.

Author:

kmaximi

Field Summary

Fields

Modifier and Type	Field	Description
static final String	WRITER_NAME	Constant value is "ObjectSaxWriter".

Fields inherited from class de.uni_trier.wi2.procake.data.io.xml.xerces_writerImpl.AbstractXMLWriter

filename, outputStream

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

DEFAULT_ENCODING, LOG_FILE_NOT_FOUND, LOG_IO_EXCEPTION, LOG_READER_NOT_FOUND, LOG_SAX_EXCEPTION, LOG_UNKNOWN_PARAMETER, 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_ATOMIC_ATTRIBUTE, TAG_ATTRIBUTE, TAG_ATTRIBUTEPATH, TAG_BYTE_ARRAY, TAG_BYTE_ARRAY_CONTENT, 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

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

LOG_CANNOT_WRITE

Constructor Summary

Constructors

Constructor	Description
ObjectWriter()

Method Summary

Modifier and Type	Method	Description
IO	copy()	overwritten copy-method from Object; use it to copy a complete operator
String	getName()	Each io component must have a name that is used in IOFactory.newIO(String).
List<Parameter>	getParameters()
void	insertNamespace(GenericXMLSchemaBasedWriter writer)	Adds the namespace-imports of this handler to the given xmlWriter.
boolean	isHandlerFor(Class value)	Checks if the io component is capable to perform the operation for objects of this class.
boolean	isWriteAtomicObjectId()
boolean	isWriteVoidObjectId()
void	preInit(AbstractParameter[] parameter)	Called directly after creating the implementation.
void	setWriteAtomicObjectId(boolean writeAtomicObjectId)
void	setWriteVoidObjectId(boolean writeVoidObjectId)
void	store(Object value, GenericXMLSchemaBasedWriter writer)	To embed xml writers into another one it must be possible to specify the parent GenericXMLSchemaBasedWriter as well as a prefix that should be probably used.
protected void	write(DataObject object, DataClass attributeType, GenericXMLSchemaBasedWriter writer)	write.
protected void	writeAggregateContent(AggregateObject object, GenericXMLSchemaBasedWriter writer)	writeAggregateContent.
protected void	writeId(DataObject object, GenericXMLSchemaBasedWriter writer)	writeId.
protected void	writeProperties(DataObject object, GenericXMLSchemaBasedWriter writer)	writeProperties.
protected void	writeVoid(VoidObject object, DataClass attributeType, GenericXMLSchemaBasedWriter writer)	writeVoid.

Methods inherited from class de.uni_trier.wi2.procake.data.io.xml.xerces_writerImpl.AbstractXMLWriter

createXMLWriter, setFilename, setOutputStream, store, storeWithFamiliarWriter

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

getFamily, postInit, 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 Details

WRITER_NAME

public static final String WRITER_NAME

Constant value is "ObjectSaxWriter".

See Also:

• Constant Field Values

Constructor Details

ObjectWriter

public ObjectWriter()

Method Details

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.

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:

insertNamespace

public void insertNamespace(GenericXMLSchemaBasedWriter writer)

Adds the namespace-imports of this handler to the given xmlWriter.

Specified by:

insertNamespace in class AbstractXMLWriter

Parameters:

writer - a GenericXMLSchemaBasedWriter object

store

public void store(Object value,
 GenericXMLSchemaBasedWriter writer)
           throws CAKEIOException

To embed xml writers into another one it must be possible to specify the parent GenericXMLSchemaBasedWriter as well as a prefix that should be probably used. If a parent writer is specified, no header will be written.

If the writer does not support XML writing, the writer should throw an UnsupportedOperationException.

 public void store(Object value, String prefix, XMLWriter writer) throws CakeIOException {
        throw new UnsupportedOperationException();
 }
 

Specified by:

store in class AbstractXMLWriter

Parameters:

value - a Object object

writer - A parent writer that is used.

Throws:

CAKEIOException - if any.

writeAggregateContent

protected void writeAggregateContent(AggregateObject object,
 GenericXMLSchemaBasedWriter writer)
                              throws InvalidNativeValueException,
IOException,
CAKEIOException

writeAggregateContent.

Parameters:

object - a AggregateObject object

writer - a GenericXMLSchemaBasedWriter object

Throws:

InvalidNativeValueException - if any.

IOException - if any.

CAKEIOException - if any.

write

protected void write(DataObject object,
 DataClass attributeType,
 GenericXMLSchemaBasedWriter writer)
              throws InvalidNativeValueException,
IOException,
CAKEIOException

write.

Parameters:

object - a DataObject object

attributeType - a DataClass object

writer - a GenericXMLSchemaBasedWriter object

Throws:

InvalidNativeValueException - if any.

IOException - if any.

CAKEIOException - if any.

writeVoid

protected void writeVoid(VoidObject object,
 DataClass attributeType,
 GenericXMLSchemaBasedWriter writer)
                  throws IOException

writeVoid.

Parameters:

object - a VoidObject object

attributeType - a DataClass object

writer - a GenericXMLSchemaBasedWriter object

Throws:

IOException - if any.

writeProperties

protected void writeProperties(DataObject object,
 GenericXMLSchemaBasedWriter writer)
                        throws IOException

writeProperties.

Parameters:

object - a DataObject object

writer - a GenericXMLSchemaBasedWriter object

Throws:

IOException - if any.

writeId

protected void writeId(DataObject object,
 GenericXMLSchemaBasedWriter writer)
                throws IOException

writeId.

Parameters:

object - a DataObject object

writer - a GenericXMLSchemaBasedWriter object

Throws:

IOException - if any.

preInit

public void preInit(AbstractParameter[] parameter)

Description copied from class: IOImpl

Called directly after creating the implementation.

Overrides:

preInit in class IOImpl

Parameters:

parameter - The parameters to initialize the implementation.

getParameters

public List<Parameter> getParameters()

Description copied from class: IOImpl

Overrides:

getParameters in class IOImpl

Returns:

Returns a list of available parameters in the implementation. This method can be called without initialization and is never null.

isWriteAtomicObjectId

public boolean isWriteAtomicObjectId()

setWriteAtomicObjectId

public void setWriteAtomicObjectId(boolean writeAtomicObjectId)

isWriteVoidObjectId

public boolean isWriteVoidObjectId()

setWriteVoidObjectId

public void setWriteVoidObjectId(boolean writeVoidObjectId)