com.cysols.iodef
Interface IodefDocumentWriter

All Known Implementing Classes:

IodefXMLDBWriter, IodefXMLFileWriter

public interface IodefDocumentWriter

The IncidentWriter interface represents the entire writer class. Conceptually, it provides writting to the xml document data.

Author:

cysol

Method Summary

void	validWrite(IODEFDocument iodef) Validates the iodef document and writesXML document included iodef document if validation is passed.
void	validWrite(String key, IODEFDocument iodef) Validates the iodef document and writes XML document included iodef document by using the specified key if validation is passed.
void	write(IODEFDocument iodefdoc) Writes the IODEF Document data.
void	write(String key, IODEFDocument iodefdoc) Writes the IODEF Document data with specified key.

Method Detail

write

void write(IODEFDocument iodefdoc)
           throws XMLWriteException

Writes the IODEF Document data.

Parameters:

iodefdoc - IODEF document instance

Throws:

XMLWriteException - if failure to write the xml document.

write

void write(String key,
           IODEFDocument iodefdoc)
           throws XMLWriteException

Writes the IODEF Document data with specified key.

Parameters:

iodefdoc - IODEF document instance

key - for writting key.

Throws:

XMLWriteException - if failure to write the xml document.

validWrite

void validWrite(IODEFDocument iodef)
                throws XMLValidationError,
                       XMLWriteException

Validates the iodef document and writesXML document included iodef document if validation is passed.

Parameters:

iodef - an iodef docuemnt

Throws:

XMLValidationError - if validation is not passed

XMLWriteException - if writing goes wrong

validWrite

void validWrite(String key,
                IODEFDocument iodef)
                throws XMLValidationError,
                       XMLWriteException

Validates the iodef document and writes XML document included iodef document by using the specified key if validation is passed.

Parameters:

key - iodef document identifier

iodef - an iodef docuemnt

Throws:

XMLValidationError - if validation is not passed

XMLWriteException - if writing goes wrong