ilog.views.gantt.project

Class IlvGanttXMLDataSource

java.lang.Object

ilog.views.gantt.project.IlvGanttDataSource

ilog.views.gantt.project.IlvGanttXMLDataSource

public class IlvGanttXMLDataSource
extends IlvGanttDataSource

An XML data source for the Gantt data model.

An XML data source implements reading and writing a Gantt data model from/to an XML data file conforming to the Gantt SDXL format, using the IlvGeneral*Reader/Writer.

Since:

JViews 6.0

Constructor Summary

Constructors

Constructor and Description
IlvGanttXMLDataSource() Creates an instance of a IlvGanttXMLDataSource.

Method Summary

Modifier and Type	Method and Description
protected void	deserializeImpl(Element element) This method must be implemented by subclasses to read their parameters from an XML configuration file.
URL	getDataURL() Returns the URL of the XML data file.
IlvGanttDocumentReader	getGanttDocumentReader() Gets the reader used to read Gantt data model from an XML file.
IlvGanttDocumentWriter	getGanttDocumentWriter() Gets the writer used to write the Gantt data model to an XML file.
void	read(IlvGanttModel ganttModel) Reads data from this data source into an IlvGanttModel
protected void	serializeImpl(Element element) This method must be implemented by subclasses to save their parameters to the XML configuration file.
void	setDataURL(URL dataURL) Sets the URL of the XML data file.
void	setGanttDocumentReader(IlvGanttDocumentReader reader) Sets the reader that will be used to read the XML file.
void	setGanttDocumentWriter(IlvGanttDocumentWriter writer) Sets the writer that will be used to write the Gantt data model to an XML file.
boolean	supportsWrite() Returns if this data source supports writing.
void	write(IlvGanttModel ganttModel) Write data from an IlvGanttModel to this data source.

Methods inherited from class ilog.views.gantt.project.IlvGanttDataSource

areActivitiesConfigured, areConstraintsConfigured, areReservationsConfigured, areResourcesConfigured, deserialize, getBaseURL, getDescription, serialize

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvGanttXMLDataSource

public IlvGanttXMLDataSource()

Creates an instance of a IlvGanttXMLDataSource.

Method Detail

setGanttDocumentReader

public void setGanttDocumentReader(IlvGanttDocumentReader reader)

Sets the reader that will be used to read the XML file.

Parameters:

reader - The IlvGanttDocumentReader

getGanttDocumentReader

public IlvGanttDocumentReader getGanttDocumentReader()

Gets the reader used to read Gantt data model from an XML file. If no reader is found a default one will be returned allowing to read IlvGeneral* Gantt objects.

Returns:

The IlvGanttDocumentReader used to read the Gantt data model from an XML file.

setGanttDocumentWriter

public void setGanttDocumentWriter(IlvGanttDocumentWriter writer)

Sets the writer that will be used to write the Gantt data model to an XML file.

Parameters:

writer - The IlvGanttDocumentWriter.

getGanttDocumentWriter

public IlvGanttDocumentWriter getGanttDocumentWriter()

Gets the writer used to write the Gantt data model to an XML file. If no writer is found a default one will be returned allowing to write IlvGeneral* Gantt objects.

Returns:

The IlvGanttDocumentWriter used to write the Gantt data model to an XML file.

getDataURL

public URL getDataURL()

Returns the URL of the XML data file.

Returns:

the XML data file URL.

setDataURL

public void setDataURL(URL dataURL)

Sets the URL of the XML data file.

Parameters:

dataURL - the URL of the XML data file.

read

public void read(IlvGanttModel ganttModel)
          throws Exception

Reads data from this data source into an IlvGanttModel

Specified by:

read in class IlvGanttDataSource

Parameters:

ganttModel - The Gantt model that will contain the data read from this data source.

Throws:

Exception - If an exception occurs while reading data.

supportsWrite

public boolean supportsWrite()

Returns if this data source supports writing. Read-only data sources must return false.

This default implementation returns true. This method must be overridden by subclasses that support writing.

Overrides:

supportsWrite in class IlvGanttDataSource

Returns:

true if this data source supports writing.

write

public void write(IlvGanttModel ganttModel)
           throws Exception

Write data from an IlvGanttModel to this data source.

This method may have an empty implementation if the data source is read-only. Read-only data sources must return false from the supportsWrite() method.

Specified by:

write in class IlvGanttDataSource

Parameters:

ganttModel - The Gantt model that contains the data to be saved to the data source.

Throws:

Exception - If an exception occurs while writing data.

serializeImpl

protected void serializeImpl(Element element)
                      throws Exception

This method must be implemented by subclasses to save their parameters to the XML configuration file.

Specified by:

serializeImpl in class IlvGanttDataSource

Parameters:

element - The DOM element to which the data source parameters are written.

Throws:

Exception - If an exception occurs while serializing the data source.

deserializeImpl

protected void deserializeImpl(Element element)
                        throws Exception

This method must be implemented by subclasses to read their parameters from an XML configuration file.

Specified by:

deserializeImpl in class IlvGanttDataSource

Parameters:

element - The DOM element to which the data source parameters are written.

Throws:

Exception - If an exception occurs while deserializing the data source.