ilog.views.gantt.xml

Class IlvGanttDocumentReader

java.lang.Object

ilog.views.gantt.xml.IlvGanttDocumentReader

All Implemented Interfaces:

IlvSDXLConstants

public class IlvGanttDocumentReader
extends Object
implements IlvSDXLConstants

The IlvGanttDocumentReader class reads an IlvGanttModel from an XML document. The document reader uses an IlvActivityReader, an IlvResourceReader, an IlvConstraintReader, and an IlvReservationReader to read the activities, resources, constraints, and reservations, respectively. The usual sequence of reading an XML document is:

   IlvGanttDocumentReader docReader = new IlvGanttDocumentReader();
   docReader.readGanttModel(anXMLDocument, aGanttModel);
 

If the XML document does not specify a single activity as an explicit root, then the reader will set an IlvNullActivity as the root activity of the data model. Similarly, if the XML document does not specify a single resource as an explicit root, then the reader will set an IlvNullResource as the root resource of the data model.

Since:

JViews 3.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvGanttDocumentReader.Context The IlvGanttDocumentReader.Context class is the context object passed to the IlvActivityReader, IlvResourceReader, IlvConstraintReader, and IlvReservationReader when an XML document is read into a Gantt model.

Field Summary

Fields inherited from interface ilog.views.gantt.xml.IlvSDXLConstants

ACTIVITIES_ELEMENT, ACTIVITY_ELEMENT, CONSTRAINT_ELEMENT, CONSTRAINTS_ELEMENT, DATE_FORMAT_ATTRIBUTE, LANGUAGE_ATTRIBUTE, RESERVATION_ELEMENT, RESERVATIONS_ELEMENT, RESOURCE_ELEMENT, RESOURCES_ELEMENT, SCHEDULE_ELEMENT

Constructor Summary

Constructors

Constructor and Description
IlvGanttDocumentReader() Creates an IlvGanttDocumentReader that uses an IlvGeneralActivityReader, an IlvGeneralResourceReader, an IlvGeneralConstraintReader, and an IlvGeneralReservationReader to read the activities, resources, constraints, and reservations, respectively.

Method Summary

Modifier and Type	Method and Description
IlvActivityReader	getActivityReader() Returns the activity reader.
IlvConstraintReader	getConstraintReader() Returns the constraint reader.
IlvReservationReader	getReservationReader() Returns the reservation reader.
IlvResourceReader	getResourceReader() Returns the resource reader.
void	readGanttModel(Document document, IlvGanttModel model) Reads a Gantt model from the given XML document.
void	readGanttModel(Element schedule, IlvGanttModel model) Reads an IlvGanttModel from a given Element.
void	setActivityReader(IlvActivityReader reader) Sets the activity reader.
void	setConstraintReader(IlvConstraintReader reader) Sets the constraint reader.
void	setReservationReader(IlvReservationReader reader) Sets the reservation reader.
void	setResourceReader(IlvResourceReader reader) Sets the resource reader.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvGanttDocumentReader

public IlvGanttDocumentReader()

Creates an IlvGanttDocumentReader that uses an IlvGeneralActivityReader, an IlvGeneralResourceReader, an IlvGeneralConstraintReader, and an IlvGeneralReservationReader to read the activities, resources, constraints, and reservations, respectively. Note that before the JViews 6.0 version, the readers used to be IlvSimple*Reader

Method Detail

getActivityReader

public IlvActivityReader getActivityReader()

Returns the activity reader. The Gantt document reader uses the activity reader to read an <activity> element.

Returns:

The activity reader.

setActivityReader

public void setActivityReader(IlvActivityReader reader)

Sets the activity reader. The Gantt document reader uses the activity reader to read an <activity> element. By default, the activity reader will not have a time reader defined. In this case, the document reader sets a time reader based upon the format specified by the dateFormat attribute of the <activities> element.

Parameters:

reader - The new activity reader.

getResourceReader

public IlvResourceReader getResourceReader()

Returns the resource reader. The Gantt document reader uses the resource reader to read a <resource> element.

Returns:

The resource reader.

setResourceReader

public void setResourceReader(IlvResourceReader reader)

Sets the resource reader. The Gantt document reader uses the resource reader to read a <resource> element.

Parameters:

reader - The new resource reader.

getConstraintReader

public IlvConstraintReader getConstraintReader()

Returns the constraint reader. The Gantt document reader uses the constraint reader to read a <constraint> element.

Returns:

The constraint reader.

setConstraintReader

public void setConstraintReader(IlvConstraintReader reader)

Sets the constraint reader. The Gantt document reader uses the constraint reader to read a <constraint> element.

Parameters:

reader - The new constraint reader.

getReservationReader

public IlvReservationReader getReservationReader()

Returns the reservation reader. The Gantt document reader uses the reservation reader to read a <reservation> element.

Returns:

The reservation reader.

setReservationReader

public void setReservationReader(IlvReservationReader reader)

Sets the reservation reader. The Gantt document reader uses the reservation reader to read a <reservation> element.

Parameters:

reader - The new reservation reader.

readGanttModel

public void readGanttModel(Document document,
                           IlvGanttModel model)
                    throws IlvGanttReaderException

Reads a Gantt model from the given XML document. The document must contain a schedule element.

Parameters:

document - The document to read from.

model - The target Gantt model.

Throws:

IlvGanttReaderException

readGanttModel

public void readGanttModel(Element schedule,
                           IlvGanttModel model)
                    throws IlvGanttReaderException

Reads an IlvGanttModel from a given Element.

Parameters:

schedule - The element to read from. Typically, this will be a <schedule> element.

model - The target Gantt model.

Throws:

IlvGanttReaderException

Since:

JViews 6.0