Top Description Inners Fields Constructors Methods
org.apache.poi.ss.util

public final Class DateFormatConverter

extends Object
Class Inheritance
Annotations
@SuppressWarnings:unused
Imports
java.text.DateFormat, .SimpleDateFormat, java.util.ArrayList, .HashMap, .List, .Locale, .Map, org.apache.logging.log4j.LogManager, .Logger, org.apache.poi.util.LocaleID

Convert java DateFormat patterns into Excel custom number formats. For example, to format a date in excel using the "dd MMMM, yyyy" pattern and Japanese locale, use the following code:

     // returns "[$-0411]dd MMMM, yyyy;@" where the [$-0411] prefix tells Excel to use the Japanese locale
     String excelFormatPattern = DateFormatConverter.convert(Locale.JAPANESE, "dd MMMM, yyyy");

     CellStyle cellStyle = workbook.createCellStyle();

     DataFormat poiFormat = workbook.createDataFormat();
     cellStyle.setDataFormat(poiFormat.getFormat(excelFormatPattern));
     cell.setCellValue(new Date());
     cell.setCellStyle(cellStyle);  // formats date as '2012年3月17日'
 
TODO Generalise this for all Excel format strings

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private static final Logger
private static Map<String, String>

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static String
public static String
convert(Locale locale, String format)

public static String
getJavaDatePattern(int style, Locale locale)

public static String
getJavaDateTimePattern(int style, Locale locale)

public static String
getJavaTimePattern(int style, Locale locale)

public static String
private static Map<String, String>
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

LOGback to summary
private static final Logger LOG
tokenConversionsback to summary
private static Map<String, String> tokenConversions

Constructor Detail

DateFormatConverterback to summary
private DateFormatConverter()

Method Detail

convertback to summary
public static String convert(Locale locale, DateFormat df)
convertback to summary
public static String convert(Locale locale, String format)
getJavaDatePatternback to summary
public static String getJavaDatePattern(int style, Locale locale)
getJavaDateTimePatternback to summary
public static String getJavaDateTimePattern(int style, Locale locale)
getJavaTimePatternback to summary
public static String getJavaTimePattern(int style, Locale locale)
getPrefixForLocaleback to summary
public static String getPrefixForLocale(Locale locale)
prepareTokenConversionsback to summary
private static Map<String, String> prepareTokenConversions()
org.apache.poi.ss.util back to summary

public Class DateFormatConverter.DateFormatTokenizer

extends Object
Class Inheritance
  • java.lang.Object
  • org.apache.poi.ss.util.DateFormatConverter.DateFormatTokenizer

Field Summary

Modifier and TypeField and Description
pack-priv String
pack-priv int

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String
public static String[]
tokenize(String format)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

formatback to summary
pack-priv String format
posback to summary
pack-priv int pos

Constructor Detail

DateFormatTokenizerback to summary
public DateFormatTokenizer(String format)

Method Detail

getNextTokenback to summary
public String getNextToken()
tokenizeback to summary
public static String[] tokenize(String format)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override