ilog.views.gantt.xml

Class IlvSDXLFileConnector

java.lang.Object

ilog.views.gantt.xml.IlvSDXLFileConnector

public class IlvSDXLFileConnector
extends Object

This class is designed to connect a SDXL file to a Gantt Chart or an IlvScheduleChart. You can use the setChart method and the setFileName method to set the chart and the SDXL file to be connected.

Since:

JViews 3.5

See Also:

setChart(ilog.views.gantt.IlvHierarchyChart), setFileName(java.lang.String)

Constructor Summary

Constructors

Constructor and Description
IlvSDXLFileConnector() Creates an IlvSDXLFileConnector.
IlvSDXLFileConnector(IlvGanttDocumentReader reader, IlvGanttDocumentWriter writer) Creates an IlvSDXLFileConnector with a specific customized XML document reader and a specific customized XML document writer.

Method Summary

Modifier and Type	Method and Description
IlvHierarchyChart	getChart() Returns the connected Gantt Chart or Schedule Chart.
String	getFileName() Returns the connected SDXL file name.
void	read() Reads the connected SDXL file and refreshes the connected chart.
void	setChart(IlvHierarchyChart chart) Sets the Gantt Chart or Schedule Chart to be connected.
void	setFileName(String file) Sets the name of the SDXL file to read or to write.
void	write() Calls this function to write the Gantt model of the connected chart to the connected file.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvSDXLFileConnector

public IlvSDXLFileConnector()

Creates an IlvSDXLFileConnector.

IlvSDXLFileConnector

public IlvSDXLFileConnector(IlvGanttDocumentReader reader,
                            IlvGanttDocumentWriter writer)

Creates an IlvSDXLFileConnector with a specific customized XML document reader and a specific customized XML document writer.

Since:

JViews 8.7

Method Detail

getFileName

public String getFileName()

Returns the connected SDXL file name.

Returns:

The connected SDXL file name.

setFileName

public void setFileName(String file)

Sets the name of the SDXL file to read or to write. This function will call read in order to refresh the Gantt model of the connected chart. You can specify a local file name or a URL. Note that if a URL is specified you can not call the method write.

Parameters:

file - The file to be connected.

getChart

public IlvHierarchyChart getChart()

Returns the connected Gantt Chart or Schedule Chart.

Returns:

The connected Gantt Chart or Schedule Chart.

See Also:

setChart(ilog.views.gantt.IlvHierarchyChart)

setChart

public void setChart(IlvHierarchyChart chart)

Sets the Gantt Chart or Schedule Chart to be connected. This function will call read in order to refresh the Gantt model of the specified chart.

Parameters:

chart - The Gantt Chart or Schedule Chart to be connected.

See Also:

getChart()

read

public void read()

Reads the connected SDXL file and refreshes the connected chart. This function creates an IlvDefaultGanttModel that receives the schedule data of the connected SDXL file. The new created IlvDefaultGanttModel is then specified to the connected chart.

If the connected file or chart is not valid, this function does nothing.

write

public void write()

Calls this function to write the Gantt model of the connected chart to the connected file.

Note that if the connected file is an URL file you can not call this function.

See Also:

setFileName(java.lang.String)