DateFunctions (Transform API)

com.oracle.endeca.transform.functions.DateFunctions

List of Date interface functions

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`DATEFORMAT_DEFAULT`

Methods Summary

Methods
Type	Name and description
`java.util.Date`	`addTime(java.util.Date attribute, java.lang.Integer timeToAdd, java.lang.String timeUnit)` Add time units to a date
`java.lang.Double`	`diffDates(java.util.Date attribute1, java.util.Date attribute2, java.lang.String timeUnit = UserFunctions.MILLISECONDS, java.lang.Boolean precisionFlag = false)` Get the difference between the two dates based on the time unit specified
`java.lang.Integer`	`getDayOfMonth(java.util.Date attribute, java.lang.String timezoneInfo = null, java.lang.String localeInfo = "en")` Get the day of month information from the date based on the timezone and locale as optional parameters
`java.lang.Integer`	`getDayOfWeek(java.util.Date attribute, java.lang.String timezoneInfo = null, java.lang.String localeInfo = "en")` Get the day of week information from the date based on the timezone and locale as optional parameters
`java.lang.Integer`	`getDayOfYear(java.util.Date attribute, java.lang.String timezoneInfo = null, java.lang.String localeInfo = "en")` Get the day of year information from the date based on the timezone and locale as optional parameters
`java.lang.Integer`	`getHour(java.util.Date attribute, java.lang.String timezoneInfo = null, java.lang.String localeInfo = "en")` Get the hour information from the date based on the timezone and locale as optional parameters
`java.lang.Long`	`getMilliSecond(java.util.Date attribute, java.lang.String timezoneInfo = null, java.lang.String localeInfo = "en")` Get the milliseconds information from the date based on the timezone and locale as optional parameters
`java.lang.Integer`	`getMinute(java.util.Date attribute, java.lang.String timezoneInfo = null, java.lang.String localeInfo = "en")` Get the minute information from the date based on the timezone and locale as optional parameters
`java.lang.Integer`	`getMonth(java.util.Date attribute, java.lang.String timezoneInfo = null, java.lang.String localeInfo = "en")` Get the month information from the date based on the timezone and locale as optional parameters
`java.lang.Long`	`getSeconds(java.util.Date attribute, java.lang.String timezoneInfo = null, java.lang.String localeInfo = "en")` Get the seconds information from the date based on the timezone and locale as optional parameters
`java.lang.Integer`	`getYear(java.util.Date attribute, java.lang.String timezoneInfo = null, java.lang.String localeInfo = "en")` Get the year information from the date based on the timezone and locale as optional parameters
`java.lang.Boolean`	`isDate(java.lang.String attribute, java.lang.String dataFormatInfo = null)` Convert a string to a date based on the date format
`java.util.Date`	`toDate(java.lang.Long epochDate)` Convert a long to a date
`java.util.Date`	`toDate(java.lang.String attribute, java.lang.String dataFormatInfo = DATEFORMAT_DEFAULT, java.lang.String timezoneInfo = null, java.lang.String localeInfo = "en")` Convert a string to a date based on given date format
`java.lang.String`	`toString(java.util.Date attribute, java.lang.String dataFormatInfo = DATEFORMAT_DEFAULT, java.lang.String timezoneInfo = null, java.lang.String localeInfo = "en")` Convert date to string
`java.util.Date`	`today(java.lang.String timezoneInfo = null, java.lang.String localeInfo = "en")` Return the current date
`java.util.Date`	`truncateDate(java.util.Date attribute, java.lang.String timeUnit)` Truncate Date based on the time unit

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class ConversionFunctions`	`toBoolean, toBoolean, toBoolean, toDate, toDouble, toDouble, toDouble, toLong, toLong, toLong, toLong, toString`
`class EnrichmentFunctions`	`detectLanguage, extractKeyPhrases, extractNounGroups, extractWhitelistTags, geotagIPAddress, geotagIPAddressGetGeocode, geotagStructuredAddress, geotagUnstructuredAddress, geotagUnstructuredAddressGetGeocode, getEntities, getSentiment, getTermSentiment, reverseGeotag, runExternalPlugin, stripTagsFromHTML, toPhoneticHash`
`class groovy.lang.Script`	groovy.lang.Script#println(), groovy.lang.Script#println(java.lang.Object), groovy.lang.Script#run(), groovy.lang.Script#run(java.io.File, [Ljava.lang.String;), groovy.lang.Script#setProperty(java.lang.String, java.lang.Object), groovy.lang.Script#getProperty(java.lang.String), groovy.lang.Script#print(java.lang.Object), groovy.lang.Script#printf(java.lang.String, java.lang.Object), groovy.lang.Script#printf(java.lang.String, [Ljava.lang.Object;), groovy.lang.Script#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.Script#evaluate(java.lang.String), groovy.lang.Script#evaluate(java.io.File), groovy.lang.Script#getBinding(), groovy.lang.Script#setBinding(groovy.lang.Binding), groovy.lang.Script#getMetaClass(), groovy.lang.Script#setMetaClass(groovy.lang.MetaClass), groovy.lang.Script#wait(long, int), groovy.lang.Script#wait(long), groovy.lang.Script#wait(), groovy.lang.Script#equals(java.lang.Object), groovy.lang.Script#toString(), groovy.lang.Script#hashCode(), groovy.lang.Script#getClass(), groovy.lang.Script#notify(), groovy.lang.Script#notifyAll()

- Field Detail
  - public static final java.lang.String DATEFORMAT_DEFAULT
- Method Detail
  - @ManagedMethod(category=FunctionCategory.DATE) java.util.Date addTime(@ManagedParameter(name="attribute", type=TypeConstants.DATE_TYPE) java.util.Date attribute, @ManagedParameter(name="timeToAdd", type=TypeConstants.INTEGER_TYPE) java.lang.Integer timeToAdd, @ManagedParameter(name="timeUnit", type=TypeConstants.STRING_TYPE, expectedValues = [UserFunctions.DAYS, UserFunctions.HOURS, UserFunctions.MINUTES, UserFunctions.SECONDS, UserFunctions.MILLISECONDS, UserFunctions.MONTHS, UserFunctions.YEARS]) java.lang.String timeUnit)
    
    Add time units to a date
    Parameters:
    date
    timeToAdd
    timeUnit - timeUnit can be MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS or YEARS
    Returns:
    the new date after adding the time unit
  - @ManagedMethod(category=FunctionCategory.DATE) java.lang.Double diffDates(@ManagedParameter(name="attribute1", type=TypeConstants.DATE_TYPE) java.util.Date attribute1, @ManagedParameter(name="attribute2", type=TypeConstants.DATE_TYPE) java.util.Date attribute2, @ManagedParameter(name="timeUnit", type=TypeConstants.STRING_TYPE, optional=true, expectedValues = [UserFunctions.DAYS, UserFunctions.HOURS, UserFunctions.MINUTES, UserFunctions.SECONDS, UserFunctions.MILLISECONDS, UserFunctions.MONTHS, UserFunctions.YEARS]) java.lang.String timeUnit = UserFunctions.MILLISECONDS, @ManagedParameter(name="precisionFlag", type=TypeConstants.BOOLEAN_TYPE, optional=true) java.lang.Boolean precisionFlag = false)
    
    Get the difference between the two dates based on the time unit specified
    Parameters:
    attribute1
    attribute2
    timeUnit - timeUnit can be MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS or YEARS
    precisionFlag - whether or not to diff with millisecond precision
    Returns:
    the difference as a Double
  - @ManagedMethod(category=FunctionCategory.DATE) java.lang.Integer getDayOfMonth(@ManagedParameter(name="attribute", type=TypeConstants.DATE_TYPE) java.util.Date attribute, @ManagedParameter(name="timeZone", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String timezoneInfo = null, @ManagedParameter(name="localeCode", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String localeInfo = "en")
    
    Get the day of month information from the date based on the timezone and locale as optional parameters
    Parameters:
    attribute
    timezoneInfo
    localeInfo
    Returns:
    the day of month information
  - @ManagedMethod(category=FunctionCategory.DATE) java.lang.Integer getDayOfWeek(@ManagedParameter(name="attribute", type=TypeConstants.DATE_TYPE) java.util.Date attribute, @ManagedParameter(name="timeZone", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String timezoneInfo = null, @ManagedParameter(name="localeCode", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String localeInfo = "en")
    
    Get the day of week information from the date based on the timezone and locale as optional parameters
    Parameters:
    attribute
    timezoneInfo
    localeInfo
    Returns:
    the day of week information
  - @ManagedMethod(category=FunctionCategory.DATE) java.lang.Integer getDayOfYear(@ManagedParameter(name="attribute", type=TypeConstants.DATE_TYPE) java.util.Date attribute, @ManagedParameter(name="timeZone", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String timezoneInfo = null, @ManagedParameter(name="localeCode", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String localeInfo = "en")
    
    Get the day of year information from the date based on the timezone and locale as optional parameters
    Parameters:
    attribute
    timezoneInfo
    localeInfo
    Returns:
    the day of year information
  - @ManagedMethod(category=FunctionCategory.DATE) java.lang.Integer getHour(@ManagedParameter(name="attribute", type=TypeConstants.DATE_TYPE) java.util.Date attribute, @ManagedParameter(name="timeZone", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String timezoneInfo = null, @ManagedParameter(name="localeCode", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String localeInfo = "en")
    
    Get the hour information from the date based on the timezone and locale as optional parameters
    Parameters:
    attribute
    timezoneInfo
    localeInfo
    Returns:
    the hour information
  - @ManagedMethod(category=FunctionCategory.DATE) java.lang.Long getMilliSecond(@ManagedParameter(name="attribute", type=TypeConstants.DATE_TYPE) java.util.Date attribute, @ManagedParameter(name="timeZone", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String timezoneInfo = null, @ManagedParameter(name="localeCode", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String localeInfo = "en")
    
    Get the milliseconds information from the date based on the timezone and locale as optional parameters
    Parameters:
    attribute
    timezoneInfo
    localeInfo
    Returns:
    the milliseconds information
  - @ManagedMethod(category=FunctionCategory.DATE) java.lang.Integer getMinute(@ManagedParameter(name="attribute", type=TypeConstants.DATE_TYPE) java.util.Date attribute, @ManagedParameter(name="timeZone", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String timezoneInfo = null, @ManagedParameter(name="localeCode", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String localeInfo = "en")
    
    Get the minute information from the date based on the timezone and locale as optional parameters
    Parameters:
    attribute
    timezoneInfo
    localeInfo
    Returns:
    the minute information
  - @ManagedMethod(category=FunctionCategory.DATE) java.lang.Integer getMonth(@ManagedParameter(name="attribute", type=TypeConstants.DATE_TYPE) java.util.Date attribute, @ManagedParameter(name="timeZone", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String timezoneInfo = null, @ManagedParameter(name="localeCode", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String localeInfo = "en")
    
    Get the month information from the date based on the timezone and locale as optional parameters
    Parameters:
    attribute
    timezoneInfo
    localeInfo
    Returns:
    the month information
  - @ManagedMethod(category=FunctionCategory.DATE) java.lang.Long getSeconds(@ManagedParameter(name="attribute", type=TypeConstants.DATE_TYPE) java.util.Date attribute, @ManagedParameter(name="timeZone", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String timezoneInfo = null, @ManagedParameter(name="localeCode", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String localeInfo = "en")
    
    Get the seconds information from the date based on the timezone and locale as optional parameters
    Parameters:
    attribute
    timezoneInfo
    localeInfo
    Returns:
    the second information
  - @ManagedMethod(category=FunctionCategory.DATE) java.lang.Integer getYear(@ManagedParameter(name="attribute", type=TypeConstants.DATE_TYPE) java.util.Date attribute, @ManagedParameter(name="timeZone", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String timezoneInfo = null, @ManagedParameter(name="localeCode", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String localeInfo = "en")
    
    Get the year information from the date based on the timezone and locale as optional parameters
    Parameters:
    attribute
    timezoneInfo
    localeInfo
    Returns:
    the year information
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.Boolean isDate(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="dateFormat", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String dataFormatInfo = null)
    
    Convert a string to a date based on the date format
    Parameters:
    attribute
    dataFormatInfo
    Returns:
    true if the string is a date
  - @ManagedMethod(category=FunctionCategory.CONVERSION, addToJson=true) java.util.Date toDate(@ManagedParameter(name="epochDate", type=TypeConstants.LONG_TYPE) java.lang.Long epochDate)
    
    Convert a long to a date
    Parameters:
    epochDate
    Returns:
    the converted date
  - @ManagedMethod(category=FunctionCategory.CONVERSION) java.util.Date toDate(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="dateFormat", type=TypeConstants.STRING_TYPE, optional = true) java.lang.String dataFormatInfo = DATEFORMAT_DEFAULT, @ManagedParameter(name="timeZone", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String timezoneInfo = null, @ManagedParameter(name="localeCode", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String localeInfo = "en")
    
    Convert a string to a date based on given date format
    Parameters:
    attribute
    dataFormatInfo
    timezoneInfo
    localeInfo
    Returns:
    the date representation of the data
  - @ManagedMethod(category=FunctionCategory.CONVERSION) java.lang.String toString(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.util.Date attribute, @ManagedParameter(name="dateFormat", type=TypeConstants.STRING_TYPE, optional = true) java.lang.String dataFormatInfo = DATEFORMAT_DEFAULT, @ManagedParameter(name="timeZone", type=TypeConstants.STRING_TYPE, optional = true) java.lang.String timezoneInfo = null, @ManagedParameter(name="localeCode", type=TypeConstants.STRING_TYPE, optional = true) java.lang.String localeInfo = "en")
    
    Convert date to string
    Parameters:
    date
    dateFormatInfo
    timezoneInfo
    localeInfo
    Returns:
    the string derived from date and date format
  - @ManagedMethod(category=FunctionCategory.DATE) java.util.Date today(@ManagedParameter(name="timeZone", type=TypeConstants.STRING_TYPE, optional = true) java.lang.String timezoneInfo = null, @ManagedParameter(name="localeCode", type=TypeConstants.STRING_TYPE, optional = true) java.lang.String localeInfo = "en")
    
    Return the current date
    Parameters:
    timezoneInfo
    localeInfo
    Returns:
    the current date
  - @ManagedMethod(category=FunctionCategory.DATE) java.util.Date truncateDate(@ManagedParameter(name="attribute", type=TypeConstants.DATE_TYPE) java.util.Date attribute, @ManagedParameter(name="timeUnit", type=TypeConstants.STRING_TYPE, expectedValues = [UserFunctions.DAYS, UserFunctions.HOURS, UserFunctions.MINUTES, UserFunctions.SECONDS, UserFunctions.MILLISECONDS, UserFunctions.MONTHS, UserFunctions.YEARS]) java.lang.String timeUnit)
    
    Truncate Date based on the time unit
    Parameters:
    date
    timeUnit - timeUnit can be MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS or YEARS
    Returns:
    the truncated date

Summary:
Field
Method

| Detail:
Field
Method

[Groovy] Class DateFunctions

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String DATEFORMAT_DEFAULT

Method Detail

@ManagedMethod(category=FunctionCategory.STRING) java.lang.Boolean isDate(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="dateFormat", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String dataFormatInfo = null)

@ManagedMethod(category=FunctionCategory.CONVERSION, addToJson=true) java.util.Date toDate(@ManagedParameter(name="epochDate", type=TypeConstants.LONG_TYPE) java.lang.Long epochDate)