Start | Index | Overview • PREV | UP | NEXT

net.simplace.pipe.processors.DateListCreatorProcessor

Version: 1.0

This processor takes an start date and generates a java.util.Collection of dates. Following parameters are available:

startDate (mandatory)
First date put in the collection.
startDateFormat (optional)
A DateFormat representation the startDate is given in (Default: "YYYY-MM-DD")
endDate | dayCount (mandatory) End-Date in the same format as startDate or the number of dates as an integer value.
stepSize (optional) The step size (in days) the dates are generated in (Default: 1)
resultParamKey (mandatory) The map key the resulting java.util.Collection is stored in.
resultElementFormat (optional) The format the java.util.Collection elements are stored in. Supported values are:
- java.time.LocalDateTime, so that the result is a Collection
- a string representation of DateFormat, so that the result is a Collection
(Default: same value as startDate)

public class DateListCreatorProcessor extends
net.simplace.pipe.control.FWProcessor {
// Public Constructors
public DateListCreatorProcessor();

// Constants
public static final long DAY_IN_MILLIES;
public static final String INKEY_START_DATE;
public static final String INKEY_START_DATE_FORMAT;
public static final String INKEY_END_DATE;
public static final String INKEY_DAY_COUNT;
public static final String INKEY_STEP_SIZE;
public static final String INKEY_RESULT_FORMAT;
public static final String OUTKEY_RESULT_PARAM_KEY;

// Public Instance Methods

public boolean checkInParameterMap(); // Defines
net.simplace.pipe.control.FWProcessor

Checks whether the in-channel contains all required parameters.

// Protected Instance Methods

protected boolean process() throws PipeLineException; // Defines
net.simplace.pipe.control.FWProcessor

Stores day in the output java.util.Collection.
returns ever {@code true}

protected void putFormatedDateCollection(LocalDateTime aDate, Collection
aDestCol) throws PipeLineException;

Converts a date given in milli seconds to the output format (given by parameter 'resultElementFormat') and puts it to the collection.

aDate Millis
aDestCol

}

Hierarchy: java.lang.Object - net.simplace.pipe.control.FWProcessor - DateListCreatorProcessor