Top Description Inners Fields Constructors Methods
org.h2.expression.function

public final Class DateTimeFormatFunction

extends FunctionN
Class Inheritance
Imports
java.time.DateTimeException, .Instant, .LocalDate, .LocalDateTime, .LocalTime, .OffsetDateTime, .OffsetTime, .ZoneId, .ZoneOffset, java.time.format.DateTimeFormatter, .DateTimeFormatterBuilder, java.time.temporal.ChronoField, .TemporalAccessor, .TemporalQueries, java.time.zone.ZoneRules, java.util.Locale, .Objects, org.h2.api.ErrorCode, org.h2.engine.SessionLocal, org.h2.expression.Expression, .TypedValueExpression, org.h2.message.DbException, org.h2.util.JSR310Utils, .SmallLRUCache, org.h2.value.TypeInfo, .Value, .ValueTime, .ValueTimestampTimeZone, .ValueVarchar

A date-time format function.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
private static class

Field Summary

Modifier and TypeField and Description
private static final SmallLRUCache<DateTimeFormatFunction.CacheKey, DateTimeFormatFunction.CacheValue>
public static final int
FORMATDATETIME

FORMATDATETIME() (non-standard).

private final int
private static final String[]
public static final int
PARSEDATETIME

PARSEDATETIME() (non-standard).

Constructor Summary

AccessConstructor and Description
public
DateTimeFormatFunction(int function)

Method Summary

Modifier and TypeMethod and Description
public static String

Returns:

the formatted date
formatDateTime
(SessionLocal
the session
session
,
Value
the date to format
date
,
String
the format string
format
,
String
the locale
locale
,
String
the time zone
timeZone
)

Formats a date using a format string.

private static DateTimeFormatFunction.CacheValue
getDateFormat(String format, String locale, String timeZone)

public String
private static ZoneOffset
getTimeOffset(ZoneId zoneId, String timeZone)

public Value
getValue(SessionLocal
the session
session
,
Value
the value of first argument, or null
v1
,
Value
the value of second argument, or null
v2
,
Value
the value of third argument, or null
v3
)

Overrides org.h2.expression.function.FunctionN.getValue.

Returns the value of this function.

private static ZoneId
getZoneId(String timeZone)

public Expression
optimize(SessionLocal
the session
session
)

Implements abstract org.h2.expression.Expression.optimize.

Try to optimize the expression.

public static ValueTimestampTimeZone

Returns:

the parsed date
parseDateTime
(SessionLocal
the session
session
,
String
the date to parse
date
,
String
the parsing format
format
,
String
the locale
locale
,
String
the time zone
timeZone
)

Parses a date using a format string.

Inherited from org.h2.expression.function.FunctionN:
getUnenclosedSQLgetValue

Field Detail

CACHEback to summary
private static final SmallLRUCache<DateTimeFormatFunction.CacheKey, DateTimeFormatFunction.CacheValue> CACHE
FORMATDATETIMEback to summary
public static final int FORMATDATETIME

FORMATDATETIME() (non-standard).

functionback to summary
private final int function
NAMESback to summary
private static final String[] NAMES
PARSEDATETIMEback to summary
public static final int PARSEDATETIME

PARSEDATETIME() (non-standard).

Constructor Detail

DateTimeFormatFunctionback to summary
public DateTimeFormatFunction(int function)

Method Detail

formatDateTimeback to summary
public static String formatDateTime(SessionLocal session, Value date, String format, String locale, String timeZone)

Formats a date using a format string.

Parameters
session:SessionLocal

the session

date:Value

the date to format

format:String

the format string

locale:String

the locale

timeZone:String

the time zone

Returns:String

the formatted date

getDateFormatback to summary
private static DateTimeFormatFunction.CacheValue getDateFormat(String format, String locale, String timeZone)
getNameback to summary
public String getName()

Implements org.h2.expression.function.NamedExpression.getName.

Doc from org.h2.expression.function.NamedExpression.getName.

Get the name.

Returns:String

the name in uppercase

Annotations
@Override
getTimeOffsetback to summary
private static ZoneOffset getTimeOffset(ZoneId zoneId, String timeZone)
getValueback to summary
public Value getValue(SessionLocal session, Value v1, Value v2, Value v3)

Overrides org.h2.expression.function.FunctionN.getValue.

Doc from org.h2.expression.function.FunctionN.getValue.

Returns the value of this function.

Parameters
session:SessionLocal

the session

v1:Value

the value of first argument, or null

v2:Value

the value of second argument, or null

v3:Value

the value of third argument, or null

Returns:Value

the resulting value

Annotations
@Override
getZoneIdback to summary
private static ZoneId getZoneId(String timeZone)
optimizeback to summary
public Expression optimize(SessionLocal session)

Implements abstract org.h2.expression.Expression.optimize.

Doc from org.h2.expression.Expression.optimize.

Try to optimize the expression.

Parameters
session:SessionLocal

the session

Returns:Expression

the optimized expression

Annotations
@Override
parseDateTimeback to summary
public static ValueTimestampTimeZone parseDateTime(SessionLocal session, String date, String format, String locale, String timeZone)

Parses a date using a format string.

Parameters
session:SessionLocal

the session

date:String

the date to parse

format:String

the parsing format

locale:String

the locale

timeZone:String

the time zone

Returns:ValueTimestampTimeZone

the parsed date

org.h2.expression.function back to summary

private final Class DateTimeFormatFunction.CacheKey

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final String
private final String
private final String

Constructor Summary

AccessConstructor and Description
pack-priv
CacheKey(String format, String locale, String timeZone)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

formatback to summary
private final String format
localeback to summary
private final String locale
timeZoneback to summary
private final String timeZone

Constructor Detail

CacheKeyback to summary
pack-priv CacheKey(String format, String locale, String timeZone)

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
org.h2.expression.function back to summary

private final Class DateTimeFormatFunction.CacheValue

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv final DateTimeFormatter
pack-priv final ZoneId

Constructor Summary

AccessConstructor and Description
pack-priv
CacheValue(DateTimeFormatter formatter, ZoneId zoneId)

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

formatterback to summary
pack-priv final DateTimeFormatter formatter
zoneIdback to summary
pack-priv final ZoneId zoneId

Constructor Detail

CacheValueback to summary
pack-priv CacheValue(DateTimeFormatter formatter, ZoneId zoneId)