COM.TIBCO.hawk.config.rbengine.schedule

Class Schedules

java.lang.Object

COM.TIBCO.hawk.config.rbengine.schedule.Schedules

All Implemented Interfaces:

RBEConfigObject, java.lang.Cloneable

public class Schedules
extends java.lang.Object
implements RBEConfigObject, java.lang.Cloneable

A Schedules contains a list of Schedule and PeriodGroup objects. The PeriodGroup is referenced in a Schedules using a PeriodGroupReference.

Unlike rulebases, All the schedules which is used by the TIBCO Hawk Agent is kept in a single file instead of individual files as in the case of rulebases. The Agent transfer the entire list of Schedule objects in a Schedules to and from a Console API application. For example to retrieve and send a Schedules to and from an agent, see SchedulesXML.

Please refer

Schedule, PeriodGroup, PeriodGroupReference, SchedulesXML

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILE_EXTENSION The default file extension of a schedule file.
static java.lang.String	SchedulesFileName The file name of a schedule file.
static java.lang.String	SchedulesName The default name of a schedules.

Constructor Summary

Constructors

Constructor and Description
Schedules() Creates a Schedules.
Schedules(java.io.Reader reader) Creates a Schedules from the reader.
Schedules(Schedule[] schedules) Creates a Schedules with the specifed name and list of schedules.
Schedules(java.lang.String name) Deprecated.
Schedules(java.util.Vector schedules) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addPeriodGroup(PeriodGroup periodGroup) Adds a period group to the current list of PeriodGroup in this Schedules.
void	addSchedule(Schedule schedule) Adds a schedule to the current list of schedules.
java.lang.Object	clone() Returns a copy of this Schedules object
boolean	equals(java.lang.Object o) Compares the specified Schedules objects for equality.
void	fromXML(java.io.Reader reader) Deprecated.
Attributes	getAttributes() Returns the attributes for this Schedules.
java.lang.String	getAuthor() Deprecated.
long	getChecksum() Returns the checksum value of this Schedules object.
java.lang.String	getComment() Deprecated.
java.lang.String	getFileExtension() Returns file extension based on the schedules.
java.lang.String	getLastModification() Deprecated.
java.lang.String	getName() Returns the Schedules name.
PeriodGroup	getPeriodGroup(java.lang.String name) Returns a PeriodGroup of the specified name.
PeriodGroup[]	getPeriodGroups() Returns a list of PeriodGroup in this Schedules.
Schedule	getSchedule(java.lang.String name) Returns a schedule of the specified name.
java.lang.String[]	getScheduleNames() Deprecated.
Schedule[]	getSchedules() Returns a list of schedules.
java.util.Vector	getSchedulesAsVector() Deprecated.
java.lang.String	getScheduleUsingPeriodGroup(java.lang.String periodGroupName) Gets the schedule that uses the specified PeriodGroup.
static Schedules	load(java.lang.String filename) Deprecated.
static void	loadFromFile(java.lang.String path) Deprecated.
void	removePeriodGroup(PeriodGroup periodGroup) Removes a period group from the current list of PeriodGroup in this Schedules.
void	removeSchedule(Schedule schedule) Deprecated.
void	removeSchedule(java.lang.String name) Removes a schedule from the current list of schedules.
void	renamePeriodGroup(java.lang.String oldName, java.lang.String newName) Renames a PeriodGroup.
void	saveToFile(java.lang.String filename) Deprecated.
void	setAttributes(Attributes attributes) Sets the attributes for this Schedules.
void	setAuthor(java.lang.String author) Deprecated.
void	setComment(java.lang.String comment) Deprecated.
void	setLastModification(java.lang.String lastModification) Deprecated.
void	setPeriodGroups(PeriodGroup[] periodGroups) Replaces a list of PeriodGroup in this Schedules with the specified list.
void	setSchedules(Schedule[] schedules) Replaces the list of schedules with the specified list.
void	setSchedules(java.util.Vector v) Deprecated.
java.lang.String	toString() Returns the string representation of the Schedules object.
java.lang.String	toXML() Deprecated.
void	toXML(java.io.Writer writer) Writes the Schedules object to Writer in XML format.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FILE_EXTENSION

public static final java.lang.String FILE_EXTENSION

The default file extension of a schedule file.

SchedulesName

public static java.lang.String SchedulesName

The default name of a schedules.

SchedulesFileName

public static java.lang.String SchedulesFileName

The file name of a schedule file. This is the file name used by Agent and repository when loading and saving a schedule file.

Constructor Detail

Schedules

public Schedules()

Creates a Schedules. The new Schedules object has no Schedule object.

Schedules

public Schedules(java.lang.String name)

Deprecated.

Creates a Schedules with the specifed name. The new schedules does not contain any Schedule object.

Parameters:

name - Schedules name

Schedules

public Schedules(java.util.Vector schedules)

Deprecated.

Creates a Schedules with the specifed name and list of schedules.

Parameters:

schedules - a list of schedule.

Schedules

public Schedules(Schedule[] schedules)

Creates a Schedules with the specifed name and list of schedules.

Parameters:

schedules - a list of schedule.

Throws:

java.lang.IllegalArgumentException - if schedules is null

Schedules

public Schedules(java.io.Reader reader)
          throws ScheduleException

Creates a Schedules from the reader. The reader contains a schedules in an XML format. This constructor is useful when recreating a Schedules from SchedulesXML object:

    Schedules schedules = new Schedules(aScheduleXML.getXMLReader());
 

Parameters:

reader - a reader which contain the schedule in XML format.

Throws:

ScheduleException - if not able to create schedules from the reader.

Method Detail

getFileExtension

public java.lang.String getFileExtension()

Returns file extension based on the schedules.

Specified by:

getFileExtension in interface RBEConfigObject

Returns:

the file extension of the schedules.

getSchedulesAsVector

public java.util.Vector getSchedulesAsVector()

Deprecated.

Returns a list of schedules as vector.

getSchedules

public Schedule[] getSchedules()

Returns a list of schedules.

setSchedules

public void setSchedules(Schedule[] schedules)

Replaces the list of schedules with the specified list.

Throws:

java.lang.IllegalArgumentException - if schedules is null

setSchedules

public void setSchedules(java.util.Vector v)

Deprecated.

Replaces the list of schedules with the specified list.

getSchedule

public Schedule getSchedule(java.lang.String name)

Returns a schedule of the specified name.

Returns:

the instance of Schedule in this Schedules object with the specified name.

getPeriodGroups

public PeriodGroup[] getPeriodGroups()

Returns a list of PeriodGroup in this Schedules.

setPeriodGroups

public void setPeriodGroups(PeriodGroup[] periodGroups)

Replaces a list of PeriodGroup in this Schedules with the specified list.

Parameters:

periodGroups - the new period groups for this Schedules.

Throws:

java.lang.IllegalArgumentException - if schedules is null

addPeriodGroup

public void addPeriodGroup(PeriodGroup periodGroup)

Adds a period group to the current list of PeriodGroup in this Schedules. If the period group of the same name exist, it will be replaced.

Parameters:

periodGroup - period group to be added.

Throws:

java.lang.IllegalArgumentException - if periodGroup is null

renamePeriodGroup

public void renamePeriodGroup(java.lang.String oldName,
                              java.lang.String newName)

Renames a PeriodGroup.

If the PeriodGroup to be renamed is referenced by a schedule, the schedule will be updated to used the new PeriodGroup name.

removePeriodGroup

public void removePeriodGroup(PeriodGroup periodGroup)

Removes a period group from the current list of PeriodGroup in this Schedules. If the period group does not exist, no action is taken.

Parameters:

periodGroup - period group to be removed.

Throws:

java.lang.IllegalArgumentException - if periodGroupName is null or use by a schedule.

getPeriodGroup

public PeriodGroup getPeriodGroup(java.lang.String name)

Returns a PeriodGroup of the specified name.

Returns:

instance of PeriodGroup in this Schedules object with the specified name.

getScheduleUsingPeriodGroup

public java.lang.String getScheduleUsingPeriodGroup(java.lang.String periodGroupName)

Gets the schedule that uses the specified PeriodGroup.

Returns:

the name of first schedule found to use the given PeriodGroup.

getName

public java.lang.String getName()

Returns the Schedules name.

Specified by:

getName in interface RBEConfigObject

setAuthor

public void setAuthor(java.lang.String author)

Deprecated.

Sets the author of this Schedules.

Parameters:

name - name of the author.

setLastModification

public void setLastModification(java.lang.String lastModification)

Deprecated.

Sets the last modification time stamp of this Schedules.

Parameters:

lastModification - timeStamp of the last modification.

setComment

public void setComment(java.lang.String comment)

Deprecated.

Sets the comment for this Schedules.

Parameters:

comment - text for the comment.

getAuthor

public java.lang.String getAuthor()

Deprecated.

Returns the author for this Schedules.

getLastModification

public java.lang.String getLastModification()

Deprecated.

Returns the last modification for this Schedules.

getComment

public java.lang.String getComment()

Deprecated.

Returns the comment for this Schedules.

setAttributes

public void setAttributes(Attributes attributes)

Sets the attributes for this Schedules.

Throws:

java.lang.IllegalArgumentException - if attributes is null

getAttributes

public Attributes getAttributes()

Returns the attributes for this Schedules. The Attributes contains attributes suchs as author, last modification record, and comment.

Please refer

Attributes

addSchedule

public void addSchedule(Schedule schedule)

Adds a schedule to the current list of schedules. If the schedule of the same name exist, it will be replaced.

Parameters:

schedule - schedule to be added.

Throws:

java.lang.IllegalArgumentException - if schedule is null

removeSchedule

public void removeSchedule(Schedule schedule)

Deprecated.

Removes a schedule from the current list of schedules. If the schedule does not exist, no action is taken.

Parameters:

schedule - schedule to be removed.

Throws:

java.lang.IllegalArgumentException - if schedule is null

removeSchedule

public void removeSchedule(java.lang.String name)

Removes a schedule from the current list of schedules.

getScheduleNames

public java.lang.String[] getScheduleNames()

Deprecated.

Returns the names of all Schedule objects.

toXML

public java.lang.String toXML()

Deprecated.

Returns an XML string that may be used to restore the Schedules using

fromXML.

Please refer

#fromXML(Reader)

toXML

public void toXML(java.io.Writer writer)
           throws RBEConfigObjectException

Writes the Schedules object to Writer in XML format.

Specified by:

toXML in interface RBEConfigObject

Parameters:

writer - the writer where the XML output will be written.

Throws:

RBEConfigObjectException

fromXML

public void fromXML(java.io.Reader reader)
             throws ScheduleException

Deprecated.

Restores Schedules from a reader in XML format.

Parameters:

reader - the reader where the XML output will be read.

Throws:

ScheduleException

equals

public boolean equals(java.lang.Object o)

Compares the specified Schedules objects for equality.

Overrides:

equals in class java.lang.Object

Parameters:

o - Schedules to be compared

Returns:

true if objects are equal

toString

public java.lang.String toString()

Returns the string representation of the Schedules object.

Overrides:

toString in class java.lang.Object

getChecksum

public long getChecksum()

Returns the checksum value of this Schedules object.

Specified by:

getChecksum in interface RBEConfigObject

Returns:

the checksum value of this Schedules object.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Returns a copy of this Schedules object

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

loadFromFile

public static void loadFromFile(java.lang.String path)
                         throws RBEConfigObjectException

Deprecated.

Loads a Schedules object from an absolute fully qualified path.

Parameters:

path - the full path name of the file to load

Throws:

RBEConfigObjectException

saveToFile

public void saveToFile(java.lang.String filename)
                throws RBEConfigObjectException

Deprecated.

Saves Schedules object to a file.

Parameters:

filename - a fully qualify file name.

Throws:

RBEConfigObjectException - if I/O error occurs.

load

public static Schedules load(java.lang.String filename)
                      throws RBEConfigObjectException

Deprecated.

Creates Schedules object from file

Parameters:

filename - filename

Returns:

Schedules

Throws:

RBEConfigObjectException