atg.service.scheduler
Class SchedulePropertyValueParser
java.lang.Object
atg.service.scheduler.SchedulePropertyValueParser
- All Implemented Interfaces:
- atg.nucleus.PropertyValueParser, atg.service.scheduler.LocalePropertyValueParser
public class SchedulePropertyValueParser
- extends java.lang.Object
- implements atg.service.scheduler.LocalePropertyValueParser
This parser will turn a String into one of the implementations
of Schedule. The String should have one of these forms. Note that
the placement of single spaces is important (multiple spaces cannot
substitute for single spaces), and unintentional trailing spaces
may also be problematic.
- "at {date}" - this will create an AbsoluteSchedule that will
occur at the specified {date}. {date} is parsed according to the
DateFormat of the default locale. For example: "at 3:15 PM".
- "in {delay} [unit of time]" - this will create a RelativeSchedule
that will occur after the specified delay. See below for "unit of time."
- "every {period} [unit of time] [in {delay} [unit of time]] - This
will create a PeriodicSchedule that will occur every {period} unit of
time. (See below for "unit of time.") If the "in" clause is specified,
then this will wait for the specified delay before starting the periodic
schedule. For example "every 500 msec in 10 sec".
- "calendar {calendar specification}" - This will create a
CalendarSchedule according to the {calendar specification}. See
CalendarSchedule for a specification on how the calendar schedule
is specified. For example: "calendar * 1,15 . 15 5".
Specifying the unit of time is optional in RelativeSchedule
and
PeriodicSchedule
. It may be one of the following. If not specified, the
unit of time defaults to seconds
:
- msec
- sec
- second
- seconds
- min
- minute
- minutes
- hour
- hours
- day
- days
- See Also:
AbsoluteSchedule
,
RelativeSchedule
,
PeriodicSchedule
,
CalendarSchedule
,
BeanConfigurator
Nested Class Summary |
protected static class |
SchedulePropertyValueParser.ScheduleFactoryImpl
This is a generic implementation of the schedulefactory that just checks
the first work of the schedule string and if it is what is expected,
returns true. |
Method Summary |
static SchedulePropertyValueParser |
getInstance()
|
static java.util.ResourceBundle |
getResources(java.util.Locale pLocale)
|
java.lang.Object |
parsePropertyValue(java.lang.String pValue,
java.lang.Class pClass)
|
java.lang.Object |
parsePropertyValue(java.lang.String pValue,
java.lang.Class pClass,
java.util.Locale pLocale)
Parses the specified value into and object of the specified class. |
static void |
registerSchedule(atg.service.scheduler.ScheduleFactory pSchedule)
We would very much like to take advantage of the prexisting schedule object
within dynamo, but also allow users to register and create there own. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
CLASS_VERSION
public static java.lang.String CLASS_VERSION
- Class version string
sRegisteredScheduleTypes
public static java.util.List sRegisteredScheduleTypes
SchedulePropertyValueParser
public SchedulePropertyValueParser()
getResources
public static java.util.ResourceBundle getResources(java.util.Locale pLocale)
getInstance
public static SchedulePropertyValueParser getInstance()
registerSchedule
public static void registerSchedule(atg.service.scheduler.ScheduleFactory pSchedule)
- We would very much like to take advantage of the prexisting schedule object
within dynamo, but also allow users to register and create there own.
The super class we be repossible for createing the existing schedule
objects, while user schedule objects will be registerd with this service.
parsePropertyValue
public java.lang.Object parsePropertyValue(java.lang.String pValue,
java.lang.Class pClass)
throws atg.nucleus.PropertyValueParseException
- Specified by:
parsePropertyValue
in interface atg.nucleus.PropertyValueParser
- Throws:
atg.nucleus.PropertyValueParseException
parsePropertyValue
public java.lang.Object parsePropertyValue(java.lang.String pValue,
java.lang.Class pClass,
java.util.Locale pLocale)
throws atg.nucleus.PropertyValueParseException
- Parses the specified value into and object of the specified class.
- Specified by:
parsePropertyValue
in interface atg.service.scheduler.LocalePropertyValueParser
- Parameters:
pValue
- the String value of the property to be parsedpClass
- the type of object the property should parse topContext
- the Context in which the parsing is to take place.
This can be used to find other objects named by the property value.
- Throws:
atg.nucleus.PropertyValueParseException