ilog.views.gantt.xml

Class IlvGanttDocumentWriter

java.lang.Object

ilog.views.gantt.xml.IlvGanttDocumentWriter

All Implemented Interfaces:

IlvSDXLConstants

public class IlvGanttDocumentWriter
extends Object
implements IlvSDXLConstants

The IlvGanttDocumentWriter class writes an IlvGanttModel to an XML document. The document writer uses an IlvActivityWriter, an IlvResourceWriter, an IlvConstraintWriter, and an IlvReservationWriter to write the activities, resources, constraints, and reservations, respectively. The usual sequence of writing an XML document is:

   IlvGanttDocumentWriter docWriter = new IlvGanttDocumentWriter();
   docWriter.writeGanttModel(anXMLDocument, aGanttModel);
 

If the root activity of the Gantt model is an instanceof IlvNullActivity, then the root activity will be omitted from the XML document. Similarly, if the root resource of the Gantt model is an instanceof IlvNullResource, then the root resource will be omitted from the XML document.

Since:

JViews 3.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvGanttDocumentWriter.Context The IlvGanttDocumentWriter.Context class is the context object passed to the IlvActivityWriter, IlvResourceWriter, IlvConstraintWriter, and IlvReservationWriter when a Gantt model is being written to an XML document.

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
IlvGanttDocumentWriter() Deprecated. Please use the constructor that takes a Locale argument.
IlvGanttDocumentWriter(Locale locale) Creates an IlvGanttDocumentWriter that uses an IlvGeneralActivityWriter, an IlvGeneralResourceWriter, an IlvGeneralConstraintWriter, and an IlvGeneralReservationWriter to write the activities, resources, constraints, and reservations, respectively.

Method Summary

Modifier and Type	Method and Description
IlvActivityWriter	getActivityWriter() Returns the activity writer.
IlvConstraintWriter	getConstraintWriter() Returns the constraint writer.
String	getDateFormat() Returns the date format used to write date variables of the activities.
String	getDescription() Returns the description to be written for the Gantt model.
Locale	getLocale() Returns the locale used to convert dates to a textual representation.
PropertyEditor	getPropertyEditor(Class type) Returns the specified property editor for a type of properties.
IlvReservationWriter	getReservationWriter() Returns the reservation writer.
IlvResourceWriter	getResourceWriter() Returns the resource writer.
String	getTitle() Returns the title to be written for the Gantt model.
String	getVersion() Returns the version of the writer.
void	setActivityWriter(IlvActivityWriter writer) Sets the activity writer.
void	setConstraintWriter(IlvConstraintWriter writer) Sets the constraint writer.
void	setDateFormat(String format) Specifies the date format used to write date variables of the activities.
void	setDescription(String desc) Sets the description to be written for the Gantt model.
void	setLocale(Locale locale) Sets the locale used to convert dates to a textual representation.
void	setPropertyEditor(Class type, PropertyEditor pe) Specifies a property editor for a type of properties.
void	setReservationWriter(IlvReservationWriter writer) Sets the reservation writer.
void	setResourceWriter(IlvResourceWriter writer) Sets the resource writer.
void	setTitle(String title) Sets the title to be written for the Gantt model.
void	setVersion(String version) Returns the version of the writer.
void	writeGanttModel(Document document, IlvGanttModel model) Writes the specified Gantt model to the given XML document.
void	writeGanttModel(Element schedule, IlvGanttModel model) Writes the content of an IlvGanttModel to the given Element.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvGanttDocumentWriter

@Deprecated
public IlvGanttDocumentWriter()

Deprecated. Please use the constructor that takes a Locale argument.

Creates an IlvGanttDocumentWriter that doesn't write a locale designator into the XML file.

Deprecated Since:

JViews 8.1

IlvGanttDocumentWriter

public IlvGanttDocumentWriter(Locale locale)

Creates an IlvGanttDocumentWriter that uses an IlvGeneralActivityWriter, an IlvGeneralResourceWriter, an IlvGeneralConstraintWriter, and an IlvGeneralReservationWriter to write the activities, resources, constraints, and reservations, respectively. Note that before the JViews 6.0 version, the writers used to be IlvSimple*Writer

Parameters:

locale - The locale used to convert dates to a textual representation, see setLocale(java.util.Locale). Usually the value passed here is IlvLocaleUtil.getCurrentLocale().

Since:

JViews 8.1

See Also:

setLocale(java.util.Locale)

Method Detail

getTitle

public String getTitle()

Returns the title to be written for the Gantt model.

Returns:

The title to be written for the Gantt model.

See Also:

writeGanttModel(Document, IlvGanttModel)

setTitle

public void setTitle(String title)

Sets the title to be written for the Gantt model.

Parameters:

title - The title to be written for the Gantt model.

See Also:

writeGanttModel(Document, IlvGanttModel)

getDescription

public String getDescription()

Returns the description to be written for the Gantt model.

Returns:

The description for the Gantt model to write

See Also:

writeGanttModel(Document, IlvGanttModel)

setDescription

public void setDescription(String desc)

Sets the description to be written for the Gantt model.

Parameters:

desc - The description to be written for the Gantt model.

See Also:

writeGanttModel(Document, IlvGanttModel)

getVersion

public String getVersion()

Returns the version of the writer.

Returns:

The version of the writer.

See Also:

writeGanttModel(Document, IlvGanttModel)

setVersion

public void setVersion(String version)

Returns the version of the writer.

Parameters:

version - The version of the writer.

See Also:

writeGanttModel(Document, IlvGanttModel)

getLocale

public Locale getLocale()

Returns the locale used to convert dates to a textual representation.

Returns:

a locale or null

Since:

JViews 8.1

See Also:

setLocale(java.util.Locale)

setLocale

public void setLocale(Locale locale)

Sets the locale used to convert dates to a textual representation.

If the given locale is non-null, it is used to convert dates to a textual representation, and is designated through an xml:lang attribute. Such XML files can then be read in any locale.

If the given locale is null, the current locale is used to convert dates to a textual representation, and no locale designator is written into the XML file. Such XML files can only be read is the same locale as the one in which they were written.

Parameters:

locale - A locale, or null.

Since:

JViews 8.1

See Also:

getLocale()

getDateFormat

public String getDateFormat()

Returns the date format used to write date variables of the activities. This function returns the date format used by the activity writer.

Returns:

The date format.

See Also:

setDateFormat(java.lang.String), getActivityWriter()

setDateFormat

public void setDateFormat(String format)

Specifies the date format used to write date variables of the activities. This function will change the date format of the activity writer.

Parameters:

format - The new date format.

See Also:

getActivityWriter()

getActivityWriter

public IlvActivityWriter getActivityWriter()

Returns the activity writer. The Gantt model writer uses the activity writer to write an <activity> element.

Returns:

The activity writer

setActivityWriter

public void setActivityWriter(IlvActivityWriter writer)

Sets the activity writer. The Gantt document writer uses the activity writer to write an <activity> element.

Parameters:

writer - The new activity writer.

getResourceWriter

public IlvResourceWriter getResourceWriter()

Returns the resource writer. The Gantt document writer uses the resource writer to write a <resource> element.

Returns:

The resource writer.

setResourceWriter

public void setResourceWriter(IlvResourceWriter writer)

Sets the resource writer. The Gantt document writer uses the resource writer to write a <resource> element.

Parameters:

writer - The new resource writer.

getConstraintWriter

public IlvConstraintWriter getConstraintWriter()

Returns the constraint writer. The Gantt document writer uses the constraint writer to write a <constraint> element.

Returns:

The constraint writer.

setConstraintWriter

public void setConstraintWriter(IlvConstraintWriter writer)

Sets the constraint writer. The Gantt document writer uses the constraint writer to write a <constraint> element.

Parameters:

writer - The new constraint writer.

getReservationWriter

public IlvReservationWriter getReservationWriter()

Returns the reservation writer. The Gantt document writer uses the reservation writer to write a <reservation> element.

Returns:

The reservation writer.

setReservationWriter

public void setReservationWriter(IlvReservationWriter writer)

Sets the reservation writer. The Gantt document writer uses the reservation writer to write a <reservation> element.

Parameters:

writer - The new reservation writer.

getPropertyEditor

public PropertyEditor getPropertyEditor(Class type)

Returns the specified property editor for a type of properties.

Parameters:

type - A type of some properties.

Returns:

The specified property editor for the given type, or null if none has been set.

Since:

JViews 8.7

See Also:

setPropertyEditor(Class, PropertyEditor)

setPropertyEditor

public void setPropertyEditor(Class type,
                              PropertyEditor pe)

Specifies a property editor for a type of properties. This property editor will be used for properties of the given type instead of the default JViews property editor.

Parameters:

type - A type of some properties.

pe - A property editor for the given type.

Since:

JViews 8.7

See Also:

getPropertyEditor(Class)

writeGanttModel

public void writeGanttModel(Element schedule,
                            IlvGanttModel model)
                     throws Exception

Writes the content of an IlvGanttModel to the given Element. This method also writes the version, the title and the description of the Gantt model. These parameters are obtained by calling getVersion(), getTitle(), and getDescription() respectively.

Parameters:

schedule - The element to write to. Typically, this will be a <schedule> element. The element must be already added to a Document. In other words, the element.getOwnerDocument() method must return a valid Document.

model - The source Gantt model.

Throws:

Exception - if an error occurs while writing the Gantt data model.

Since:

JViews 6.0

writeGanttModel

public void writeGanttModel(Document document,
                            IlvGanttModel model)
                     throws Exception

Writes the specified Gantt model to the given XML document.

Parameters:

document - The document to write to.

model - The source Gantt model.

Throws:

Exception - if an error occurs while writing the Gantt data model.