CoordELFunctions (Apache Oozie Core 4.1.0-cdh5.13.1 API)

java.lang.Object
- org.apache.oozie.coord.CoordELFunctions

```
public class CoordELFunctions
extends java.lang.Object
```
This class implements the EL function related to coordinator

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CONFIGURATION`
`static java.lang.String`	`COORD_ACTION`
`static java.lang.String`	`DATASET`
`static long`	`DAY_MSEC`
`static java.lang.String`	`DIR_SEPARATOR`
`static long`	`HOUR_MSEC`
`static java.lang.String`	`INSTANCE_SEPARATOR`
`static java.lang.String`	`LATEST_EL_USE_CURRENT_TIME`
`static long`	`MINUTE_MSEC`
`static long`	`MONTH_MSEC`
`static long`	`YEAR_MSEC`

Constructor Summary

Constructors
Constructor and Description

CoordELFunctions()

Constructors
Constructor and Description
`CoordELFunctions()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`configureEvaluator(ELEvaluator evaluator, SyncCoordDataset ds, SyncCoordAction coordAction)` Configure an evaluator with data set and application specific information.
`static java.lang.String`	`coord_actualTime_echo()`
`static java.lang.String`	`coord_conf(java.lang.String property)` Return a job configuration property for the coordinator.
`static java.lang.String`	`coord_days_echo(java.lang.String n)`
`static java.lang.String`	`coord_endOfDay_echo(java.lang.String n)`
`static java.lang.String`	`coord_endOfMonth_echo(java.lang.String n)`
`static java.lang.String`	`coord_hours_echo(java.lang.String n)`
`static java.lang.String`	`coord_minutes_echo(java.lang.String n)`
`static java.lang.String`	`coord_months_echo(java.lang.String n)`
`static java.lang.String`	`coord_user()` Return the user that submitted the coordinator job.
`static java.lang.String`	`evalAndWrap(ELEvaluator eval, java.lang.String expr)` Helper method to wrap around with "${..}".
`static java.util.List<java.lang.Integer>`	`expandOffsetTimes(java.util.Calendar startCal, java.util.Calendar endCal, ELEvaluator eval)` Takes two offset times and returns a list of multiples of the frequency offset from the effective nominal time that occur between them.
`static java.util.Calendar`	`getCurrentInstance(java.util.Date effectiveTime, int[] instanceCount)` Find the current instance based on effectiveTime (i.e Action_Creation_Time or Action_Start_Time)
`static java.util.TimeZone`	`getDatasetTZ()`
`static TimeUnit`	`getDSTimeUnit(ELEvaluator eval)`
`static java.util.Calendar`	`getEffectiveNominalTime()`
`static java.lang.String`	`ph1_coord_absolute_echo(java.lang.String date)`
`static java.lang.String`	`ph1_coord_actionId_echo()`
`static java.lang.String`	`ph1_coord_actualTime_echo_wrap()`
`static java.lang.String`	`ph1_coord_current_echo(java.lang.String n)`
`static java.lang.String`	`ph1_coord_currentRange_echo(java.lang.String start, java.lang.String end)`
`static java.lang.String`	`ph1_coord_dataIn_echo(java.lang.String n)`
`static java.lang.String`	`ph1_coord_dataOut_echo(java.lang.String n)`
`static java.lang.String`	`ph1_coord_dateOffset_echo(java.lang.String n, java.lang.String offset, java.lang.String unit)`
`static java.lang.String`	`ph1_coord_dateTzOffset_echo(java.lang.String n, java.lang.String timezone)`
`static int`	`ph1_coord_days(int val)` Used in defining the frequency in 'day' unit.
`static java.lang.String`	`ph1_coord_daysInMonth_echo(java.lang.String n)`
`static int`	`ph1_coord_endOfDays(int val)` Used in defining the frequency in 'day' unit and specify the "end of day" property.
`static int`	`ph1_coord_endOfMonths(int val)` Used in defining the frequency in 'month' unit and specify the "end of month" property.
`static java.lang.String`	`ph1_coord_epochTime_echo(java.lang.String dateTime, java.lang.String millis)`
`static java.lang.String`	`ph1_coord_formatTime_echo(java.lang.String dateTime, java.lang.String format)`
`static java.lang.String`	`ph1_coord_future_echo(java.lang.String n, java.lang.String instance)`
`static java.lang.String`	`ph1_coord_futureRange_echo(java.lang.String start, java.lang.String end, java.lang.String instance)`
`static int`	`ph1_coord_hours(int val)` Used in defining the frequency in 'hour' unit.
`static java.lang.String`	`ph1_coord_hoursInDay_echo(java.lang.String n)`
`static java.lang.String`	`ph1_coord_latest_echo(java.lang.String n)`
`static java.lang.String`	`ph1_coord_latestRange_echo(java.lang.String start, java.lang.String end)`
`static int`	`ph1_coord_minutes(int val)` Used in defining the frequency in 'minute' unit.
`static int`	`ph1_coord_months(int val)` Used in defining the frequency in 'month' unit.
`static java.lang.String`	`ph1_coord_name_echo()`
`static java.lang.String`	`ph1_coord_nominalTime_echo_fixed()`
`static java.lang.String`	`ph1_coord_nominalTime_echo_wrap()`
`static java.lang.String`	`ph1_coord_nominalTime_echo()`
`static java.lang.String`	`ph1_coord_offset_echo(java.lang.String n, java.lang.String timeUnit)`
`static java.lang.String`	`ph1_coord_tzOffset_echo()`
`static java.lang.String`	`ph2_coord_absolute_echo(java.lang.String date)`
`static java.lang.String`	`ph2_coord_absolute_range(java.lang.String startInstance, int end)`
`static java.lang.String`	`ph2_coord_actionId()` Return Action Id.
`static java.lang.String`	`ph2_coord_actualTime()` Return Action Start time.
`static java.lang.String`	`ph2_coord_current_echo(java.lang.String n)`
`static java.lang.String`	`ph2_coord_current(int n)` Determine the date-time in Oozie processing timezone of n-th dataset instance.
`static java.lang.String`	`ph2_coord_currentRange_echo(java.lang.String start, java.lang.String end)`
`static java.lang.String`	`ph2_coord_currentRange(int start, int end)` Determine the date-time in Oozie processing timezone of current dataset instances from start to end offsets from the nominal time.
`static java.lang.String`	`ph2_coord_dateOffset(java.lang.String strBaseDate, int offset, java.lang.String unit)` Returns a date string that is offset from 'strBaseDate' by the amount specified.
`static java.lang.String`	`ph2_coord_dateTzOffset(java.lang.String strBaseDate, java.lang.String timezone)` Returns a date string that is offset from 'strBaseDate' by the difference from Oozie processing timezone to the given timezone.
`static int`	`ph2_coord_daysInMonth(int n)` Calculate number of days in one month for n-th dataset instance.
`static java.lang.String`	`ph2_coord_epochTime(java.lang.String dateTimeStr, java.lang.String millis)` Return Action Id.
`static java.lang.String`	`ph2_coord_formatTime(java.lang.String dateTimeStr, java.lang.String format)` Convert from standard date-time formatting to a desired format.
`static java.lang.String`	`ph2_coord_future_echo(java.lang.String n, java.lang.String instance)`
`static java.lang.String`	`ph2_coord_futureRange_echo(java.lang.String start, java.lang.String end, java.lang.String instance)`
`static int`	`ph2_coord_hoursInDay(int n)` Determine how many hours is on the date of n-th dataset instance.
`static java.lang.String`	`ph2_coord_latest_echo(java.lang.String n)`
`static java.lang.String`	`ph2_coord_latestRange_echo(java.lang.String start, java.lang.String end)`
`static java.lang.String`	`ph2_coord_name()` Return Job Name.
`static java.lang.String`	`ph2_coord_nominalTime()` Return nominal time or Action Creation Time.
`static java.lang.String`	`ph2_coord_offset_echo(java.lang.String n, java.lang.String timeUnit)`
`static java.lang.String`	`ph2_coord_offset(int n, java.lang.String timeUnit)` Determine the date-time in Oozie processing timezone of the given offset from the dataset effective nominal time.
`static int`	`ph2_coord_tzOffset()` Calculate the difference of timezone offset in minutes between dataset and coordinator job.
`static java.lang.String`	`ph3_coord_actionId()`
`static java.lang.String`	`ph3_coord_actualTime()`
`static java.lang.String`	`ph3_coord_dataIn(java.lang.String dataInName)` Used to specify a list of URI's that are used as input dir to the workflow job.
`static java.lang.String`	`ph3_coord_dataOut(java.lang.String dataOutName)` Used to specify a list of URI's that are output dir of the workflow job.
`static java.lang.String`	`ph3_coord_dateOffset(java.lang.String strBaseDate, int offset, java.lang.String unit)`
`static java.lang.String`	`ph3_coord_dateTzOffset(java.lang.String strBaseDate, java.lang.String timezone)`
`static int`	`ph3_coord_daysInMonth(int n)`
`static java.lang.String`	`ph3_coord_epochTime(java.lang.String dateTimeStr, java.lang.String millis)`
`static java.lang.String`	`ph3_coord_formatTime(java.lang.String dateTimeStr, java.lang.String format)`
`static java.lang.String`	`ph3_coord_future(int n, int instance)` Determine the date-time in Oozie processing timezone of n-th future available dataset instance from nominal Time but not beyond the instance specified as 'instance.
`static java.lang.String`	`ph3_coord_futureRange(int start, int end, int instance)` Determine the date-time in Oozie processing timezone of the future available dataset instances from start to end offsets from nominal Time but not beyond the instance specified as 'instance'.
`static int`	`ph3_coord_hoursInDay(int n)`
`static java.lang.String`	`ph3_coord_latest(int n)` Determine the date-time in Oozie processing timezone of n-th latest available dataset instance.
`static java.lang.String`	`ph3_coord_latestRange(int start, int end)` Determine the date-time in Oozie processing timezone of latest available dataset instances from start to end offsets from the nominal time.
`static java.lang.String`	`ph3_coord_name()`
`static java.lang.String`	`ph3_coord_nominalTime()`
`static int`	`ph3_coord_tzOffset()`
`static java.util.Calendar`	`resolveOffsetRawTime(int n, TimeUnit timeUnit, ELEvaluator eval)` Resolve the offset time from the effective nominal time

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DATASET
```
public static final java.lang.String DATASET
```
    See Also:
    Constant Field Values
  - COORD_ACTION
```
public static final java.lang.String COORD_ACTION
```
    See Also:
    Constant Field Values
  - CONFIGURATION
```
public static final java.lang.String CONFIGURATION
```
    See Also:
    Constant Field Values
  - LATEST_EL_USE_CURRENT_TIME
```
public static final java.lang.String LATEST_EL_USE_CURRENT_TIME
```
    See Also:
    Constant Field Values
  - INSTANCE_SEPARATOR
```
public static final java.lang.String INSTANCE_SEPARATOR
```
    See Also:
    Constant Field Values
  - DIR_SEPARATOR
```
public static final java.lang.String DIR_SEPARATOR
```
    See Also:
    Constant Field Values
  - MINUTE_MSEC
```
public static final long MINUTE_MSEC
```
    See Also:
    Constant Field Values
  - HOUR_MSEC
```
public static final long HOUR_MSEC
```
    See Also:
    Constant Field Values
  - DAY_MSEC
```
public static final long DAY_MSEC
```
    See Also:
    Constant Field Values
  - MONTH_MSEC
```
public static final long MONTH_MSEC
```
    See Also:
    Constant Field Values
  - YEAR_MSEC
```
public static final long YEAR_MSEC
```
    See Also:
    Constant Field Values
- Constructor Detail
  - CoordELFunctions
```
public CoordELFunctions()
```
- Method Detail
  - ph1_coord_days
```
public static int ph1_coord_days(int val)
```
    Used in defining the frequency in 'day' unit.
    domain: val > 0 and should be integer.
    
    Parameters:
    val - frequency in number of days.
    
    Returns:
    number of days and also set the frequency timeunit to "day"
  - ph1_coord_months
```
public static int ph1_coord_months(int val)
```
    Used in defining the frequency in 'month' unit.
    domain: val > 0 and should be integer.
    
    Parameters:
    val - frequency in number of months.
    
    Returns:
    number of months and also set the frequency timeunit to "month"
  - ph1_coord_hours
```
public static int ph1_coord_hours(int val)
```
    Used in defining the frequency in 'hour' unit.
    parameter value domain: val > 0 and should be integer.
    
    Parameters:
    val - frequency in number of hours.
    
    Returns:
    number of minutes and also set the frequency timeunit to "minute"
  - ph1_coord_minutes
```
public static int ph1_coord_minutes(int val)
```
    Used in defining the frequency in 'minute' unit.
    domain: val > 0 and should be integer.
    
    Parameters:
    val - frequency in number of minutes.
    
    Returns:
    number of minutes and also set the frequency timeunit to "minute"
  - ph1_coord_endOfDays
```
public static int ph1_coord_endOfDays(int val)
```
    Used in defining the frequency in 'day' unit and specify the "end of day" property.
    Every instance will start at 00:00 hour of each day.
    domain: val > 0 and should be integer.
    
    Parameters:
    val - frequency in number of days.
    
    Returns:
    number of days and also set the frequency timeunit to "day" and end_of_duration flag to "day"
  - ph1_coord_endOfMonths
```
public static int ph1_coord_endOfMonths(int val)
```
    Used in defining the frequency in 'month' unit and specify the "end of month" property.
    Every instance will start at first day of each month at 00:00 hour.
    domain: val > 0 and should be integer.
    
    Parameters:
    val: - frequency in number of months.
    
    Returns:
    number of months and also set the frequency timeunit to "month" and end_of_duration flag to "month"
  - ph2_coord_tzOffset
```
public static int ph2_coord_tzOffset()
```
    Calculate the difference of timezone offset in minutes between dataset and coordinator job.
    Depends on:
    1. Timezone of both dataset and job
    2. Action creation Time
    
    Returns:
    difference in minutes (DataSet TZ Offset - Application TZ offset)
  - ph3_coord_tzOffset
```
public static int ph3_coord_tzOffset()
```
  - ph2_coord_dateOffset
```
public static java.lang.String ph2_coord_dateOffset(java.lang.String strBaseDate,
                                    int offset,
                                    java.lang.String unit)
                                             throws java.lang.Exception
```
    Returns a date string that is offset from 'strBaseDate' by the amount specified. The unit can be one of DAY, MONTH, HOUR, MINUTE, MONTH.
    
    Parameters:
    strBaseDate - The base date
    offset - any number
    unit - one of DAY, MONTH, HOUR, MINUTE, MONTH
    
    Returns:
    the offset date string
    
    Throws:
    
    java.lang.Exception
  - ph3_coord_dateOffset
```
public static java.lang.String ph3_coord_dateOffset(java.lang.String strBaseDate,
                                    int offset,
                                    java.lang.String unit)
                                             throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - ph2_coord_dateTzOffset
```
public static java.lang.String ph2_coord_dateTzOffset(java.lang.String strBaseDate,
                                      java.lang.String timezone)
                                               throws java.lang.Exception
```
    Returns a date string that is offset from 'strBaseDate' by the difference from Oozie processing timezone to the given timezone. It will account for daylight saving time based on the given 'strBaseDate' and 'timezone'.
    
    Parameters:
    strBaseDate - The base date
    timezone -
    
    Returns:
    the offset date string
    
    Throws:
    
    java.lang.Exception
  - ph3_coord_dateTzOffset
```
public static java.lang.String ph3_coord_dateTzOffset(java.lang.String strBaseDate,
                                      java.lang.String timezone)
                                               throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - ph3_coord_future
```
public static java.lang.String ph3_coord_future(int n,
                                int instance)
                                         throws java.lang.Exception
```
    Determine the date-time in Oozie processing timezone of n-th future available dataset instance from nominal Time but not beyond the instance specified as 'instance.
    It depends on:
    1. Data set frequency
    2. Data set Time unit (day, month, minute)
    3. Data set Time zone/DST
    4. End Day/Month flag
    5. Data set initial instance
    6. Action Creation Time
    7. Existence of dataset's directory
    
    Parameters:
    n - :instance count
    domain: n >= 0, n is integer
    instance: - How many future instance it should check? value should be >=0
    
    Returns:
    date-time in Oozie processing timezone of the n-th instance
    
    Throws:
    
    java.lang.Exception
  - ph3_coord_futureRange
```
public static java.lang.String ph3_coord_futureRange(int start,
                                     int end,
                                     int instance)
                                              throws java.lang.Exception
```
    Determine the date-time in Oozie processing timezone of the future available dataset instances from start to end offsets from nominal Time but not beyond the instance specified as 'instance'.
    It depends on:
    1. Data set frequency
    2. Data set Time unit (day, month, minute)
    3. Data set Time zone/DST
    4. End Day/Month flag
    5. Data set initial instance
    6. Action Creation Time
    7. Existence of dataset's directory
    
    Parameters:
    start - : start instance offset
    domain: start >= 0, start is integer
    end - : end instance offset
    domain: end >= 0, end is integer
    instance: - How many future instance it should check? value should be >=0
    
    Returns:
    date-time in Oozie processing timezone of the instances from start to end offsets delimited by comma.
    
    Throws:
    
    java.lang.Exception
  - ph2_coord_nominalTime
```
public static java.lang.String ph2_coord_nominalTime()
                                              throws java.lang.Exception
```
    Return nominal time or Action Creation Time.
    
    Returns:
    coordinator action creation or materialization date time
    
    Throws:
    
    java.lang.Exception - if unable to format the Date object to String
  - ph3_coord_nominalTime
```
public static java.lang.String ph3_coord_nominalTime()
                                              throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - ph2_coord_formatTime
```
public static java.lang.String ph2_coord_formatTime(java.lang.String dateTimeStr,
                                    java.lang.String format)
                                             throws java.lang.Exception
```
    Convert from standard date-time formatting to a desired format.
    
    Parameters:
    dateTimeStr - - A timestamp in standard (ISO8601) format.
    format - - A string representing the desired format.
    
    Returns:
    coordinator action creation or materialization date time
    
    Throws:
    
    java.lang.Exception - if unable to format the Date object to String
  - ph3_coord_formatTime
```
public static java.lang.String ph3_coord_formatTime(java.lang.String dateTimeStr,
                                    java.lang.String format)
                                             throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - ph2_coord_epochTime
```
public static java.lang.String ph2_coord_epochTime(java.lang.String dateTimeStr,
                                   java.lang.String millis)
                                            throws java.lang.Exception
```
    Return Action Id.
    Convert from standard date-time formatting to a Unix epoch time.
    
    Parameters:
    dateTimeStr - - A timestamp in standard (ISO8601) format.
    millis - - "true" to include millis; otherwise will only include seconds
    
    Returns:
    coordinator action creation or materialization date time
    
    Throws:
    
    java.lang.Exception - if unable to format the Date object to String
  - ph3_coord_epochTime
```
public static java.lang.String ph3_coord_epochTime(java.lang.String dateTimeStr,
                                   java.lang.String millis)
                                            throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - ph2_coord_actionId
```
public static java.lang.String ph2_coord_actionId()
                                           throws java.lang.Exception
```
    Return Action Id.
    
    Returns:
    coordinator action Id
    
    Throws:
    
    java.lang.Exception
  - ph3_coord_actionId
```
public static java.lang.String ph3_coord_actionId()
                                           throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - ph2_coord_name
```
public static java.lang.String ph2_coord_name()
                                       throws java.lang.Exception
```
    Return Job Name.
    
    Returns:
    coordinator name
    
    Throws:
    
    java.lang.Exception
  - ph3_coord_name
```
public static java.lang.String ph3_coord_name()
                                       throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - ph2_coord_actualTime
```
public static java.lang.String ph2_coord_actualTime()
                                             throws java.lang.Exception
```
    Return Action Start time.
    
    Returns:
    coordinator action start time
    
    Throws:
    
    java.lang.Exception - if unable to format the Date object to String
  - ph3_coord_actualTime
```
public static java.lang.String ph3_coord_actualTime()
                                             throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - ph3_coord_dataIn
```
public static java.lang.String ph3_coord_dataIn(java.lang.String dataInName)
```
    Used to specify a list of URI's that are used as input dir to the workflow job.
    Look for two evaluator-level variables
    A) .datain. B) .datain..unresolved
    A defines the current list of URI.
    B defines whether there are any unresolved EL-function (i.e latest)
    If there are something unresolved, this function will echo back the original function
    otherwise it sends the uris.
    
    Parameters:
    dataInName - : Datain name
    
    Returns:
    the list of URI's separated by INSTANCE_SEPARATOR
    if there are unresolved EL function (i.e. latest) , echo back
    the function without resolving the function.
  - ph3_coord_dataOut
```
public static java.lang.String ph3_coord_dataOut(java.lang.String dataOutName)
```
    Used to specify a list of URI's that are output dir of the workflow job.
    Look for one evaluator-level variable
    dataout.
    It defines the current list of URI.
    otherwise it sends the uris.
    
    Parameters:
    dataOutName - : Dataout name
    
    Returns:
    the list of URI's separated by INSTANCE_SEPARATOR
  - ph2_coord_current
```
public static java.lang.String ph2_coord_current(int n)
                                          throws java.lang.Exception
```
    Determine the date-time in Oozie processing timezone of n-th dataset instance.
    It depends on:
    1. Data set frequency
    2. Data set Time unit (day, month, minute)
    3. Data set Time zone/DST
    4. End Day/Month flag
    5. Data set initial instance
    6. Action Creation Time
    
    Parameters:
    n - instance count domain: n is integer
    
    Returns:
    date-time in Oozie processing timezone of the n-th instance returns 'null' means n-th instance is earlier than Initial-Instance of DS
    
    Throws:
    
    java.lang.Exception
  - ph2_coord_currentRange
```
public static java.lang.String ph2_coord_currentRange(int start,
                                      int end)
                                               throws java.lang.Exception
```
    Determine the date-time in Oozie processing timezone of current dataset instances from start to end offsets from the nominal time.
    It depends on:
    1. Data set frequency
    2. Data set Time unit (day, month, minute)
    3. Data set Time zone/DST
    4. End Day/Month flag
    5. Data set initial instance
    6. Action Creation Time
    
    Parameters:
    start - :start instance offset
    domain: start <= 0, start is integer
    end - :end instance offset
    domain: end <= 0, end is integer
    
    Returns:
    date-time in Oozie processing timezone of the instances from start to end offsets delimited by comma.
    If the current instance time of the dataset based on the Action Creation Time is earlier than the Initial-Instance of DS an empty string is returned. If an instance within the range is earlier than Initial-Instance of DS that instance is ignored
    
    Throws:
    
    java.lang.Exception
  - ph2_coord_offset
```
public static java.lang.String ph2_coord_offset(int n,
                                java.lang.String timeUnit)
                                         throws java.lang.Exception
```
    Determine the date-time in Oozie processing timezone of the given offset from the dataset effective nominal time.
    It depends on:
    1. Data set frequency
    2. Data set Time Unit
    3. Data set Time zone/DST
    4. Data set initial instance
    5. Action Creation Time
    
    Parameters:
    n - offset amount (integer)
    timeUnit - TimeUnit for offset n ("MINUTE", "HOUR", "DAY", "MONTH", "YEAR")
    
    Returns:
    date-time in Oozie processing timezone of the given offset from the dataset effective nominal time
    
    Throws:
    
    java.lang.Exception - if there was a problem formatting
  - ph2_coord_hoursInDay
```
public static int ph2_coord_hoursInDay(int n)
                                throws java.lang.Exception
```
    Determine how many hours is on the date of n-th dataset instance.
    It depends on:
    1. Data set frequency
    2. Data set Time unit (day, month, minute)
    3. Data set Time zone/DST
    4. End Day/Month flag
    5. Data set initial instance
    6. Action Creation Time
    
    Parameters:
    n - instance count
    domain: n is integer
    
    Returns:
    number of hours on that day
    returns -1 means n-th instance is earlier than Initial-Instance of DS
    
    Throws:
    
    java.lang.Exception
  - ph3_coord_hoursInDay
```
public static int ph3_coord_hoursInDay(int n)
                                throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - ph2_coord_daysInMonth
```
public static int ph2_coord_daysInMonth(int n)
                                 throws java.lang.Exception
```
    Calculate number of days in one month for n-th dataset instance.
    It depends on:
    1. Data set frequency .
    2. Data set Time unit (day, month, minute)
    3. Data set Time zone/DST
    4. End Day/Month flag
    5. Data set initial instance
    6. Action Creation Time
    
    Parameters:
    n - instance count. domain: n is integer
    
    Returns:
    number of days in that month
    returns -1 means n-th instance is earlier than Initial-Instance of DS
    
    Throws:
    
    java.lang.Exception
  - ph3_coord_daysInMonth
```
public static int ph3_coord_daysInMonth(int n)
                                 throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - ph3_coord_latest
```
public static java.lang.String ph3_coord_latest(int n)
                                         throws java.lang.Exception
```
    Determine the date-time in Oozie processing timezone of n-th latest available dataset instance.
    It depends on:
    1. Data set frequency
    2. Data set Time unit (day, month, minute)
    3. Data set Time zone/DST
    4. End Day/Month flag
    5. Data set initial instance
    6. Action Creation Time
    7. Existence of dataset's directory
    
    Parameters:
    n - :instance count
    domain: n <= 0, n is integer
    
    Returns:
    date-time in Oozie processing timezone of the n-th instance
    returns 'null' means n-th instance is earlier than Initial-Instance of DS
    
    Throws:
    
    java.lang.Exception
  - ph3_coord_latestRange
```
public static java.lang.String ph3_coord_latestRange(int start,
                                     int end)
                                              throws java.lang.Exception
```
    Determine the date-time in Oozie processing timezone of latest available dataset instances from start to end offsets from the nominal time.
    It depends on:
    1. Data set frequency
    2. Data set Time unit (day, month, minute)
    3. Data set Time zone/DST
    4. End Day/Month flag
    5. Data set initial instance
    6. Action Creation Time
    7. Existence of dataset's directory
    
    Parameters:
    start - :start instance offset
    domain: start <= 0, start is integer
    end - :end instance offset
    domain: end <= 0, end is integer
    
    Returns:
    date-time in Oozie processing timezone of the instances from start to end offsets delimited by comma.
    returns 'null' means start offset instance is earlier than Initial-Instance of DS
    
    Throws:
    
    java.lang.Exception
  - configureEvaluator
```
public static void configureEvaluator(ELEvaluator evaluator,
                      SyncCoordDataset ds,
                      SyncCoordAction coordAction)
```
    Configure an evaluator with data set and application specific information.
    Helper method of associating dataset and application object
    
    Parameters:
    evaluator - : to set variables
    ds - : Data Set object
    coordAction - : Application instance
  - evalAndWrap
```
public static java.lang.String evalAndWrap(ELEvaluator eval,
                           java.lang.String expr)
                                    throws java.lang.Exception
```
    Helper method to wrap around with "${..}".
    
    Parameters:
    eval - :EL evaluator
    expr - : expression to evaluate
    
    Returns:
    Resolved expression or echo back the same expression
    
    Throws:
    
    java.lang.Exception
  - ph1_coord_current_echo
```
public static java.lang.String ph1_coord_current_echo(java.lang.String n)
```
  - ph1_coord_absolute_echo
```
public static java.lang.String ph1_coord_absolute_echo(java.lang.String date)
```
  - ph1_coord_currentRange_echo
```
public static java.lang.String ph1_coord_currentRange_echo(java.lang.String start,
                                           java.lang.String end)
```
  - ph1_coord_offset_echo
```
public static java.lang.String ph1_coord_offset_echo(java.lang.String n,
                                     java.lang.String timeUnit)
```
  - ph2_coord_current_echo
```
public static java.lang.String ph2_coord_current_echo(java.lang.String n)
```
  - ph2_coord_currentRange_echo
```
public static java.lang.String ph2_coord_currentRange_echo(java.lang.String start,
                                           java.lang.String end)
```
  - ph2_coord_offset_echo
```
public static java.lang.String ph2_coord_offset_echo(java.lang.String n,
                                     java.lang.String timeUnit)
```
  - ph2_coord_absolute_echo
```
public static java.lang.String ph2_coord_absolute_echo(java.lang.String date)
```
  - ph2_coord_absolute_range
```
public static java.lang.String ph2_coord_absolute_range(java.lang.String startInstance,
                                        int end)
                                                 throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - ph1_coord_dateOffset_echo
```
public static java.lang.String ph1_coord_dateOffset_echo(java.lang.String n,
                                         java.lang.String offset,
                                         java.lang.String unit)
```
  - ph1_coord_dateTzOffset_echo
```
public static java.lang.String ph1_coord_dateTzOffset_echo(java.lang.String n,
                                           java.lang.String timezone)
```
  - ph1_coord_epochTime_echo
```
public static java.lang.String ph1_coord_epochTime_echo(java.lang.String dateTime,
                                        java.lang.String millis)
```
  - ph1_coord_formatTime_echo
```
public static java.lang.String ph1_coord_formatTime_echo(java.lang.String dateTime,
                                         java.lang.String format)
```
  - ph1_coord_latest_echo
```
public static java.lang.String ph1_coord_latest_echo(java.lang.String n)
```
  - ph2_coord_latest_echo
```
public static java.lang.String ph2_coord_latest_echo(java.lang.String n)
```
  - ph1_coord_future_echo
```
public static java.lang.String ph1_coord_future_echo(java.lang.String n,
                                     java.lang.String instance)
```
  - ph2_coord_future_echo
```
public static java.lang.String ph2_coord_future_echo(java.lang.String n,
                                     java.lang.String instance)
```
  - ph1_coord_latestRange_echo
```
public static java.lang.String ph1_coord_latestRange_echo(java.lang.String start,
                                          java.lang.String end)
```
  - ph2_coord_latestRange_echo
```
public static java.lang.String ph2_coord_latestRange_echo(java.lang.String start,
                                          java.lang.String end)
```
  - ph1_coord_futureRange_echo
```
public static java.lang.String ph1_coord_futureRange_echo(java.lang.String start,
                                          java.lang.String end,
                                          java.lang.String instance)
```
  - ph2_coord_futureRange_echo
```
public static java.lang.String ph2_coord_futureRange_echo(java.lang.String start,
                                          java.lang.String end,
                                          java.lang.String instance)
```
  - ph1_coord_dataIn_echo
```
public static java.lang.String ph1_coord_dataIn_echo(java.lang.String n)
```
  - ph1_coord_dataOut_echo
```
public static java.lang.String ph1_coord_dataOut_echo(java.lang.String n)
```
  - ph1_coord_nominalTime_echo
```
public static java.lang.String ph1_coord_nominalTime_echo()
```
  - ph1_coord_nominalTime_echo_wrap
```
public static java.lang.String ph1_coord_nominalTime_echo_wrap()
```
  - ph1_coord_nominalTime_echo_fixed
```
public static java.lang.String ph1_coord_nominalTime_echo_fixed()
```
  - ph1_coord_actualTime_echo_wrap
```
public static java.lang.String ph1_coord_actualTime_echo_wrap()
```
  - ph1_coord_actionId_echo
```
public static java.lang.String ph1_coord_actionId_echo()
```
  - ph1_coord_name_echo
```
public static java.lang.String ph1_coord_name_echo()
```
  - coord_minutes_echo
```
public static java.lang.String coord_minutes_echo(java.lang.String n)
```
  - coord_hours_echo
```
public static java.lang.String coord_hours_echo(java.lang.String n)
```
  - coord_days_echo
```
public static java.lang.String coord_days_echo(java.lang.String n)
```
  - coord_endOfDay_echo
```
public static java.lang.String coord_endOfDay_echo(java.lang.String n)
```
  - coord_months_echo
```
public static java.lang.String coord_months_echo(java.lang.String n)
```
  - coord_endOfMonth_echo
```
public static java.lang.String coord_endOfMonth_echo(java.lang.String n)
```
  - coord_actualTime_echo
```
public static java.lang.String coord_actualTime_echo()
```
  - ph1_coord_hoursInDay_echo
```
public static java.lang.String ph1_coord_hoursInDay_echo(java.lang.String n)
```
  - ph1_coord_daysInMonth_echo
```
public static java.lang.String ph1_coord_daysInMonth_echo(java.lang.String n)
```
  - ph1_coord_tzOffset_echo
```
public static java.lang.String ph1_coord_tzOffset_echo()
```
  - getCurrentInstance
```
public static java.util.Calendar getCurrentInstance(java.util.Date effectiveTime,
                                    int[] instanceCount)
```
    Find the current instance based on effectiveTime (i.e Action_Creation_Time or Action_Start_Time)
    
    Returns:
    current instance i.e. current(0) returns null if effectiveTime is earlier than Initial Instance time of the dataset.
  - getEffectiveNominalTime
```
public static java.util.Calendar getEffectiveNominalTime()
```
  - getDSTimeUnit
```
public static TimeUnit getDSTimeUnit(ELEvaluator eval)
```
    Returns:
    dataset TimeUnit
  - getDatasetTZ
```
public static java.util.TimeZone getDatasetTZ()
```
    Returns:
    dataset TimeZone
  - coord_conf
```
public static java.lang.String coord_conf(java.lang.String property)
```
    Return a job configuration property for the coordinator.
    
    Parameters:
    property - property name.
    
    Returns:
    the value of the property, null if the property is undefined.
  - coord_user
```
public static java.lang.String coord_user()
```
    Return the user that submitted the coordinator job.
    
    Returns:
    the user that submitted the coordinator job.
  - expandOffsetTimes
```
public static java.util.List<java.lang.Integer> expandOffsetTimes(java.util.Calendar startCal,
                                                  java.util.Calendar endCal,
                                                  ELEvaluator eval)
```
    Takes two offset times and returns a list of multiples of the frequency offset from the effective nominal time that occur between them. The caller should make sure that startCal is earlier than endCal.
    As a simple example, assume its the same day: startCal is 1:00, endCal is 2:00, frequency is 20min, and effective nominal time is 1:20 -- then this method would return a list containing: -20, 0, 20, 40, 60
    
    Parameters:
    startCal - The earlier offset time
    endCal - The later offset time
    eval - The ELEvaluator to use; cannot be null
    
    Returns:
    A list of multiple of the frequency offset from the effective nominal time that occur between the startCal and endCal
  - resolveOffsetRawTime
```
public static java.util.Calendar resolveOffsetRawTime(int n,
                                      TimeUnit timeUnit,
                                      ELEvaluator eval)
```
    Resolve the offset time from the effective nominal time
    
    Parameters:
    n - offset amount (integer)
    timeUnit - TimeUnit for offset n ("MINUTE", "HOUR", "DAY", "MONTH", "YEAR")
    eval - The ELEvaluator to use; or null to use the "current" eval
    
    Returns:
    A Calendar of the offset time

Class CoordELFunctions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATASET

COORD_ACTION

CONFIGURATION

LATEST_EL_USE_CURRENT_TIME

INSTANCE_SEPARATOR

DIR_SEPARATOR

MINUTE_MSEC

HOUR_MSEC

DAY_MSEC

MONTH_MSEC

YEAR_MSEC

Constructor Detail

CoordELFunctions

Method Detail

ph1_coord_days

ph1_coord_months

ph1_coord_hours

ph1_coord_minutes

ph1_coord_endOfDays

ph1_coord_endOfMonths

ph2_coord_tzOffset

ph3_coord_tzOffset

ph2_coord_dateOffset

ph3_coord_dateOffset

ph2_coord_dateTzOffset

ph3_coord_dateTzOffset

ph3_coord_future

ph3_coord_futureRange

ph2_coord_nominalTime

ph3_coord_nominalTime

ph2_coord_formatTime

ph3_coord_formatTime

ph2_coord_epochTime

ph3_coord_epochTime

ph2_coord_actionId

ph3_coord_actionId

ph2_coord_name

ph3_coord_name

ph2_coord_actualTime

ph3_coord_actualTime

ph3_coord_dataIn

ph3_coord_dataOut

ph2_coord_current

ph2_coord_currentRange

ph2_coord_offset

ph2_coord_hoursInDay

ph3_coord_hoursInDay

ph2_coord_daysInMonth

ph3_coord_daysInMonth

ph3_coord_latest

ph3_coord_latestRange

configureEvaluator

evalAndWrap

ph1_coord_current_echo

ph1_coord_absolute_echo

ph1_coord_currentRange_echo

ph1_coord_offset_echo

ph2_coord_current_echo

ph2_coord_currentRange_echo

ph2_coord_offset_echo

ph2_coord_absolute_echo

ph2_coord_absolute_range

ph1_coord_dateOffset_echo

ph1_coord_dateTzOffset_echo

ph1_coord_epochTime_echo

ph1_coord_formatTime_echo

ph1_coord_latest_echo

ph2_coord_latest_echo

ph1_coord_future_echo

ph2_coord_future_echo

ph1_coord_latestRange_echo

ph2_coord_latestRange_echo

ph1_coord_futureRange_echo

ph2_coord_futureRange_echo