org.objectweb.dream.multiplexer
Class PeriodicAttachment

java.lang.Object
  extended byorg.objectweb.dream.multiplexer.Attachment
      extended byorg.objectweb.dream.multiplexer.PeriodicAttachment
All Implemented Interfaces:
Cloneable, Serializable

public class PeriodicAttachment
extends Attachment

This class defines a periodic attachment.

See Also:
Serialized Form

Field Summary
static String END_DATE
          The name of the key that must be used to specify the end date of this attachment in the parameters passed to the PullPushMultiplexer.attach(String[], Map[], String[], Map[], Map)
protected  long endDate
           
protected  long nextDeadline
           
static String PULLING_FREQUENCY
          The name of the key that must be used to specify the pulling frequency of this attachment in the parameters passed to the PullPushMultiplexer.attach(String[], Map[], String[], Map[], Map)
protected  long pullingFrequencyInMillis
           
static String STARTING_DATE
          The name of the key that must be used to specify the starting date of this attachment in the parameters passed to the PullPushMultiplexer.attach(String[], Map[], String[], Map[], Map)
protected  long startingDate
           
static String TIMESTAMP
          The name of the key that must be used in the context of the pull method to specify the time at which the pulling has been scheduled by the multiplexer.
 
Fields inherited from class org.objectweb.dream.multiplexer.Attachment
id, inputContexts, inputNames, inputs, outputContexts, outputNames, outputs
 
Constructor Summary
PeriodicAttachment(int id, String[] inputNames, Pull[] inputs, Map[] inputContexts, String[] outputNames, Push[] outputs, Map[] outputContexts, long startingDate, long pullingFrequencyInMillis)
          Creates a new Attachment object without an end date.
PeriodicAttachment(int id, String[] inputNames, Pull[] inputs, Map[] inputContexts, String[] outputNames, Push[] outputs, Map[] outputContexts, long startingDate, long pullingFrequencyInMillis, long endDate)
          Creates a new Attachment object
 
Method Summary
 Object clone()
          Returns a clone of this attachment.
 long getEndDate()
          Returns the endDate value.
 long getNextDeadline()
          Returns the nextDeadline value.
 long getStartingDate()
          Returns the startingDate value.
 long pullingFrequencyInMillis()
          Returns the samplingFrequencyInMillis value.
 void setEndDate(long endDate)
          Sets the endDate value.
 void setNextDeadline(long nextDeadline)
          Sets the nextDeadline value.
 
Methods inherited from class org.objectweb.dream.multiplexer.Attachment
equals, getId, getInputContexts, getInputNames, getInputs, getOutputContexts, getOutputNames, getOutputs, hashCode, setInputContexts, setInputNames, setInputs, setOutputContexts, setOutputNames, setOutputs
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

startingDate

protected long startingDate

pullingFrequencyInMillis

protected long pullingFrequencyInMillis

endDate

protected long endDate

nextDeadline

protected long nextDeadline

STARTING_DATE

public static final String STARTING_DATE
The name of the key that must be used to specify the starting date of this attachment in the parameters passed to the PullPushMultiplexer.attach(String[], Map[], String[], Map[], Map)

See Also:
Constant Field Values

END_DATE

public static final String END_DATE
The name of the key that must be used to specify the end date of this attachment in the parameters passed to the PullPushMultiplexer.attach(String[], Map[], String[], Map[], Map)

See Also:
Constant Field Values

PULLING_FREQUENCY

public static final String PULLING_FREQUENCY
The name of the key that must be used to specify the pulling frequency of this attachment in the parameters passed to the PullPushMultiplexer.attach(String[], Map[], String[], Map[], Map)

See Also:
Constant Field Values

TIMESTAMP

public static final String TIMESTAMP
The name of the key that must be used in the context of the pull method to specify the time at which the pulling has been scheduled by the multiplexer.

See Also:
Constant Field Values
Constructor Detail

PeriodicAttachment

public PeriodicAttachment(int id,
                          String[] inputNames,
                          Pull[] inputs,
                          Map[] inputContexts,
                          String[] outputNames,
                          Push[] outputs,
                          Map[] outputContexts,
                          long startingDate,
                          long pullingFrequencyInMillis,
                          long endDate)
Creates a new Attachment object

Parameters:
id - the id of the attachment
inputNames - the names of the attached inputs.
inputs - the attached inputs.
inputContexts - the contexts to be passed when pulling the inputs.
outputNames - the names of the outputs to wich intputs are attached.
outputs - the outputs to wich intputs are attached.
outputContexts - the contexts to be passed when pushing the outputs.
startingDate - attachment start date.
pullingFrequencyInMillis - time between two pulling
endDate - attachment end date

PeriodicAttachment

public PeriodicAttachment(int id,
                          String[] inputNames,
                          Pull[] inputs,
                          Map[] inputContexts,
                          String[] outputNames,
                          Push[] outputs,
                          Map[] outputContexts,
                          long startingDate,
                          long pullingFrequencyInMillis)
Creates a new Attachment object without an end date. It means that pulling never ends.

Parameters:
id - the id of the attachment
inputNames - the names of the attached inputs.
inputs - the attached inputs.
inputContexts - the contexts to be passed when pulling the inputs.
outputNames - the names of the outputs to wich intputs are attached.
outputs - the outputs to wich intputs are attached.
outputContexts - the contexts to be passed when pushing the outputs.
startingDate - attachment start date.
pullingFrequencyInMillis - time between two pulling
Method Detail

getNextDeadline

public long getNextDeadline()
Returns the nextDeadline value.

Returns:
the nextDeadline.

setNextDeadline

public void setNextDeadline(long nextDeadline)
Sets the nextDeadline value.

Parameters:
nextDeadline - the nextDeadline to set.

getStartingDate

public long getStartingDate()
Returns the startingDate value.

Returns:
the starting date.

getEndDate

public long getEndDate()
Returns the endDate value.

Returns:
the end date.

setEndDate

public void setEndDate(long endDate)
Sets the endDate value.

Parameters:
endDate - the endDate to set.

pullingFrequencyInMillis

public long pullingFrequencyInMillis()
Returns the samplingFrequencyInMillis value.

Returns:
the samplingFrequencyInMillis.

clone

public Object clone()
Returns a clone of this attachment.

Overrides:
clone in class Attachment
Returns:
a clone of this attachment.


Copyright © 2003, 2004 - INRIA Rhone-Alpes - All Rights Reserved.