ilog.views.gantt.xml

Class IlvSimpleActivityReader

java.lang.Object

ilog.views.gantt.xml.IlvSimpleActivityReader

All Implemented Interfaces:

IlvActivityReader

Direct Known Subclasses:

IlvGeneralActivityReader

public class IlvSimpleActivityReader
extends Object
implements IlvActivityReader

An IlvSimpleActivityReader reads an IlvSimpleActivity from a given Element.

Since:

JViews 3.5

Constructor Summary

Constructors

Constructor and Description
IlvSimpleActivityReader() Creates an IlvSimpleActivityReader with no

Method Summary

Modifier and Type	Method and Description
protected IlvActivity	createActivity(String id, String name, Date start, Date end) Creates an IlvSimpleActivity with the specified parameters.
IlvTimeReader	getTimeReader() Returns the time reader that is used to read the start time and the end time of the activity.
IlvActivity	readActivity(Element elem, IlvGanttDocumentReader.Context readContext) Reads an IlvSimpleActivity from a given Element.
Date	readTime(Element elem, String attr) Reads the start or the end time of the specified activity.
void	setTimeReader(IlvTimeReader reader) Sets the time reader that is used to read the start time and the end time of the activity.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvSimpleActivityReader

public IlvSimpleActivityReader()

Creates an IlvSimpleActivityReader with no

Method Detail

readActivity

public IlvActivity readActivity(Element elem,
                                IlvGanttDocumentReader.Context readContext)
                         throws IlvGanttReaderException

Reads an IlvSimpleActivity from a given Element.

Specified by:

readActivity in interface IlvActivityReader

Parameters:

elem - The given element to read from.

readContext - The read context.

Returns:

The newly created activity.

Throws:

IlvGanttReaderException

See Also:

createActivity(java.lang.String, java.lang.String, java.util.Date, java.util.Date)

createActivity

protected IlvActivity createActivity(String id,
                                     String name,
                                     Date start,
                                     Date end)

Creates an IlvSimpleActivity with the specified parameters. This method is called by readActivity. If you want to create a customized activity reader, you can override this method to create a customized activity.

Parameters:

id - The id for the new activity.

name - The name for the new activity.

start - The start time for the new activity.

end - The end time for the new activity.

Returns:

The newly created activity.

getTimeReader

public IlvTimeReader getTimeReader()

Returns the time reader that is used to read the start time and the end time of the activity. The default is that no time reader is defined and this method will return null. In this case, the IlvGanttDocumentReader will set a time reader based upon the format specified by the dateFormat attribute of the <activities> element.

Specified by:

getTimeReader in interface IlvActivityReader

Returns:

The time reader.

setTimeReader

public void setTimeReader(IlvTimeReader reader)

Sets the time reader that is used to read the start time and the end time of the activity. The default is that no time reader is defined and the IlvGanttDocumentReader will set a time reader based upon the format specified by the dateFormat attribute of the <activities> element.

Specified by:

setTimeReader in interface IlvActivityReader

Parameters:

reader - The new time reader.

readTime

public Date readTime(Element elem,
                     String attr)
              throws IlvGanttReaderException

Reads the start or the end time of the specified activity. This function uses the time reader.

Parameters:

elem - The element to read from.

attr - Indicates to read the start or the end time.

Throws:

IlvGanttReaderException

See Also:

getTimeReader(), setTimeReader(ilog.views.gantt.xml.IlvTimeReader)