Data type GregorianCalendar

Value range of the GregorianCalendar data type

FirstSpirit provides the data type GregorianCalendar for calculations with date and time values. This data type represents a Gregorian calendar and enables interpretation of different date formats as Year, Month, Day, Hour, Minute and Second. The data type provides access to a range of methods which fall back on the calendar and relevant regional schema settings of the operating system (e.g. data formats) and therefore enable formatting in different, for example country-specific date formats and parsing.

The data type GregorianCalendar can also be looked up in the Sun API documentation:

java.util.GregorianCalendar

Definition using the standard input components

Different input components can be defined in the form area of a page or section template. These form elements can then be used to insert the actual editorial contents into the page. The Standard input components supported by FirstSpirit return different data types.

The following standard input components return an object of data type GregorianCalendar:

• CMS_INPUT_DATE

Methods on GregorianCalendar objects

The table below lists all methods which can be invoked on objects of data type GregorianCalendar:

add(int, int)

Overview

add(String, int)

Overview

add(String, Number)

Overview

after(Date)

Overview

after(Object)

Overview

before(Date)

Overview

before(Object)

Overview

clear

Overview

clear(int)

Overview

compareTo(Date)

Overview

compareTo(Calendar)

Overview

compareTo(Comparable)

Overview

compareTo(Object)

Overview

equals(Date)

Overview

equals(Object)

Overview

format(String)

The method format(String) can be used to define how time and date information are to be displayed.

For this purpose, characters are used as formatting symbols. The function of a character in upper case can be different from the same character in lower case. In principal, a formatting symbol consists of one character, by specifiying more than one (maximal up to four) equal characters the format of the time or date information can be differentiated.

The following list shows all existing formatting symbols, first the frequently used ones:

• Specification of the year
  • yy: specification of the year two-digit (e.g. "96")
  • yyyy: specification of the year four-digit (e.g. "2010")
• Specification of the month
  • MM: specification of the month, if one-digit with leading 0 (e.g. "03")
  • MMM: specification of the month, three-lettered language-specific abbreviation (e.g. "Mar")
  • MMMM: specification of the month, long, language-specific (e.g. "March")
• Specification of the day
  • d: day of month (e.g. "26")
  • D: day of year (e.g. "145")
  • E: name of the weekday, three-lettered language-specific abbreviation (e.g. "Wed")
  • EEEE: name of the weekday, long, language-specific (e.g. "Wednesday")
  • F: weekday of the month (e.g. "2", i.e.. 2nd day of month x)
• Specification of the hour
  • K: hour of day, 12-hour notation (0-11) (e.g. "0")
  • h: hour of day, 12-hour notation (1-12) (e.g. "12")
  • H: hour of day, 24-hour notation (0-23) (e.g. "0")
  • k: hour of day, 24-hour notation (1-24) (e.g. "24")
  • a: specification of AM / PM (forenoon / afternoon) (e.g. "PM")
• Specification of the minute
  • m: specification of the minute one-digit (0-59) (e.g. "2")
  • mm: specification of the minute two-digit, if one-digit with leading 0 (0-59) (e.g. "02")
• Specification of the second
  • s: specification of the second one-digit (0-59) (e.g. "2")
  • ss: specification of the second two-digit, if one-digit with leading 0 (0-59) (e.g. "02")
• Specification of the week
  • w: calendar week (1-52) (e.g. "12")
  • W: week of the month (1-5) (e.g. "2")
• Specification of the time zone
  • Z: time zone according to RFC 822 (e.g. "+0200")
  • z: general name of the time zone, language-specific abbreviation (e.g. "CEST")
  • zzzz: general name of the time zone, long, language-specific (e.g. "Central European Summer Time")
• Specification of milli seconds
  • S - SSS: milli second (0-999) (e.g. "978")
• Specification of the era
  • G: era, language-specific (e.g. "AD")

These symbols can be used separately or combined. Space characters, dots, colons, comma, hyphens, slashes etc. can be used as separator. For outputting date and time information even more individual, additional text can be specified in simple inverted comma, e.g. Date:' dd.MM.yyyy, 'time:' HH:mm. If you would like to output a simple inverted comma, use '' (two inverted commas).

Examples:

• "dd.MM.yyyy G 'at' hh:mm:ss 'o'clock' z"
  Output: 20.06.2010 AD at 05:41:53 o'clock CEST
• "EEE, MMM d, ''yy"
  Output: Sun, Jun 20, '07
• "h:mm a"
  Output: 5:43 PM
• "hh 'o'clock,' zzzz"
  Output: 05 o'clock, Central European Summer Time
• "K:mm a, z"
  Output: 5:44 PM, CEST
• "yyyy.MMMM.dd G hh:mm a"
  Output: 2010.June.20 AD 05:45 PM
• "dd.MM.yyyy HH:mm:ss.SSS"
  Output: 20.06.2010 17:59:23.208

Overview

format(String, Locale)

Overview

format(String, String)

Overview

get(int)

Overview

getActualMaximum(int)

Overview

getActualMinimum(int)

Overview

getAvailableLocales

Overview

getClass

The .getClass() (in Bean syntax: .class) method returns the class of the invoking object (cf. java.lang.Class).

Invocation:

$CMS_VALUE(myString.class)$
$CMS_VALUE(myString.getClass())$

Output:

java.lang.String

Overview

getDisplayName(int, int, Locale)

Overview

getDisplayNames(int, int, Locale)

Overview

getFirstDayOfWeek

Overview

getGreatestMinimum(int)

Overview

getGregorianChange

Overview

getInstance

Overview

getInstance(TimeZone)

Overview

getInstance(Locale)

Overview

getInstance(TimeZone, Locale)

Overview

getLeastMaximum(int)

Overview

getMaximum(int)

Overview

getMinimalDaysInFirstWeek

Overview

getMinimum(int)

Overview

getTime

Overview

getTimeInMillis

Overview

getTimeZone

Overview

getWeekYear

Overview

getWeeksInWeekYear

Overview

hashCode

Overview

isCase(Object)

Overview

isLeapYear(int)

Overview

isLenient

Overview

isNull

The .isNull() (in Bean syntax: .isNull) method checks whether an expression or object is null , e.g. storeElement.isNull(). In the case of objects with complex values or objects, the object decides when it is null. The data type DomElement for example always contains an empty document, thus it is never null. For this reason, checking an empty DOM editor input component by using the method .isNull() returns the value false, whereas checking the component with .isEmpty() would return the value true.

The method .isNull() returns a Boolean value as the check result. true is the check result if the expression or object is null and false if not.

Overview

isSet(int)

Overview

isWeekDateSupported

Overview

milliseconds

Overview

minus(long)

Overview

plus(long)

Overview

print

Overview

roll(int, int)

Overview

roll(int, boolean)

Overview

set(int, int)

Overview

set(String, Number)

Overview

set(String, Object)

Overview

set(int, int, int)

Overview

set(int, int, int, int, int)

Overview

set(int, int, int, int, int, int)

Overview

setFirstDayOfWeek(int)

Overview

setGregorianChange(Date)

Overview

setLenient(boolean)

Overview

setMinimalDaysInFirstWeek(int)

Overview

setTime(Date)

Overview

setTimeInMillis(long)

Overview

setTimeZone(TimeZone)

Overview

setTimeZone(String)

Overview

setTimezone(TimeZone)

Overview

setTimezone(String)

Overview

setWeekDate(int, int, int)

Overview

toJson

Overview

toString

Overview

type

Overview