Package org.docx4j.model.fields

Class FormattingSwitchHelper

java.lang.Object

org.docx4j.model.fields.FormattingSwitchHelper

public class FormattingSwitchHelper
extends Object

Formats the string value of the field according to the three possible formatting switches: + date-and-time-formatting-switch: \@ + numeric-formatting-switch: \# + general-formatting-switch: \* Note that the general-formatting-switch arguments CHARFORMAT and MERGEFORMAT are not handled here. It is the responsibility of the calling code to handle these.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	FormattingSwitchHelper.FieldResultIsNotADateOrTimeException
private static class	FormattingSwitchHelper.FieldResultIsNotANumberException

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Map<String,String>	DATE_FORMAT_ITEMS_TO_JAVA
protected static final ThreadLocal<Map<String,SimpleDateFormat>>	DATE_FORMATS
static final int	DECORATION_DASH
static final int	DECORATION_NONE
protected static final String	DEFAULT_FORMAT_PAGE_TO_FO	Conversion of page number formats to fo as defined in w:fldSimple in w:pgNumType w:fmt
protected static final String	FO_PAGENUMBER_DECIMAL
protected static final String	FO_PAGENUMBER_LOWERALPHA
protected static final String	FO_PAGENUMBER_LOWERROMAN
protected static final String	FO_PAGENUMBER_UPPERALPHA
protected static final String	FO_PAGENUMBER_UPPERROMAN
protected static final Map<String,String>	FORMAT_PAGE_TO_FO
private static org.slf4j.Logger	log
protected static final String	MERGEFORMAT
protected static final String	NONE_STRING

Constructor Summary

Constructors

Constructor	Description
FormattingSwitchHelper()

Method Summary

Modifier and Type	Method	Description
private static void	appendDateItem(StringBuilder buffer, String dateItem)
private static void	appendNumberItem(StringBuilder buffer, String dateItem)
static String	applyFormattingSwitch(WordprocessingMLPackage wmlPackage, FldSimpleModel model, String value)
static String	applyFormattingSwitch(WordprocessingMLPackage wmlPackage, FldSimpleModel model, String value, String lang)
static String	convertDatePattern(String wordDatePattern)
static List<String>	findAllSwitchValues(String switchDef, List<String> fldParameters)
static String	findFirstSwitchValue(String switchDef, List<String> fldParameters, boolean ignoreMergeformat)
static int	findSwitch(String switchDef, int startPos, List<String> fldParameters)
private static String	firstCap(String value)
static String	formatDate(FldSimpleModel model)
static String	formatDate(FldSimpleModel model, String format, Date date)
private static String	formatDate(FldSimpleModel model, String format, Date date, String lang)
static String	formatDate(FldSimpleModel model, Date date)
private static String	formatGeneral(FldSimpleModel model, String format, String value)
private static String	formatNumber(FldSimpleModel model, String wordNumberPattern, double dub, String lang)
private static Date	getDate(FldSimpleModel model, String dateStr)
static String	getFldSimpleName(String instr)
static int	getFoPageNumberDecoration(String wordName)	Check if the page number format has a decoration (eg.
static String	getFoPageNumberFormat(String wordName)	Conversion of the word page number format to the fo page number format.
private static double	getNumber(WordprocessingMLPackage wmlPackage, FldSimpleModel model, String value)
private static SimpleDateFormat	getSimpleDateFormat(String lang)
static String	getSwitchValue(int pos, List<String> fldParameters)
static boolean	hasSwitch(String switchDef, List<String> fldParameters)
private static boolean	isAMPM(String wordDatePattern, int idx)
private static Locale	localeforLanguageTag(String locale)	Substitute for Java 7's Locale.forLanguageTag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

log

private static org.slf4j.Logger log

DATE_FORMATS

protected static final ThreadLocal<Map<String,SimpleDateFormat>> DATE_FORMATS

DEFAULT_FORMAT_PAGE_TO_FO

protected static final String DEFAULT_FORMAT_PAGE_TO_FO

Conversion of page number formats to fo as defined

• in w:fldSimple
• in w:pgNumType w:fmt

See Also:

• Constant Field Values

NONE_STRING

protected static final String NONE_STRING

FORMAT_PAGE_TO_FO

protected static final Map<String,String> FORMAT_PAGE_TO_FO

DECORATION_NONE

public static final int DECORATION_NONE

See Also:

• Constant Field Values

DECORATION_DASH

public static final int DECORATION_DASH

See Also:

• Constant Field Values

MERGEFORMAT

protected static final String MERGEFORMAT

See Also:

• Constant Field Values

FO_PAGENUMBER_DECIMAL

protected static final String FO_PAGENUMBER_DECIMAL

See Also:

• Constant Field Values

FO_PAGENUMBER_LOWERALPHA

protected static final String FO_PAGENUMBER_LOWERALPHA

See Also:

• Constant Field Values

FO_PAGENUMBER_UPPERALPHA

protected static final String FO_PAGENUMBER_UPPERALPHA

See Also:

• Constant Field Values

FO_PAGENUMBER_LOWERROMAN

protected static final String FO_PAGENUMBER_LOWERROMAN

See Also:

• Constant Field Values

FO_PAGENUMBER_UPPERROMAN

protected static final String FO_PAGENUMBER_UPPERROMAN

See Also:

• Constant Field Values

DATE_FORMAT_ITEMS_TO_JAVA

protected static final Map<String,String> DATE_FORMAT_ITEMS_TO_JAVA

Constructor Details

FormattingSwitchHelper

public FormattingSwitchHelper()

Method Details

applyFormattingSwitch

public static String applyFormattingSwitch(WordprocessingMLPackage wmlPackage,
 FldSimpleModel model,
 String value)
                                    throws Docx4JException

Throws:

Docx4JException

applyFormattingSwitch

public static String applyFormattingSwitch(WordprocessingMLPackage wmlPackage,
 FldSimpleModel model,
 String value,
 String lang)
                                    throws Docx4JException

Throws:

Docx4JException

getDate

private static Date getDate(FldSimpleModel model,
 String dateStr)
                     throws FormattingSwitchHelper.FieldResultIsNotADateOrTimeException

Throws:

FormattingSwitchHelper.FieldResultIsNotADateOrTimeException

getNumber

private static double getNumber(WordprocessingMLPackage wmlPackage,
 FldSimpleModel model,
 String value)
                         throws FormattingSwitchHelper.FieldResultIsNotANumberException

Throws:

FormattingSwitchHelper.FieldResultIsNotANumberException

formatNumber

private static String formatNumber(FldSimpleModel model,
 String wordNumberPattern,
 double dub,
 String lang)
                            throws FieldFormattingException

Throws:

FieldFormattingException

localeforLanguageTag

private static Locale localeforLanguageTag(String locale)

Substitute for Java 7's Locale.forLanguageTag

Parameters:

locale -

Returns:

appendNumberItem

private static void appendNumberItem(StringBuilder buffer,
 String dateItem)

formatGeneral

private static String formatGeneral(FldSimpleModel model,
 String format,
 String value)

firstCap

private static String firstCap(String value)

getFoPageNumberFormat

public static String getFoPageNumberFormat(String wordName)

Conversion of the word page number format to the fo page number format.

Parameters:

wordName - word page number format

Returns:

null if the wordName is null, the correspondig fo value if present or a default.

getFoPageNumberDecoration

public static int getFoPageNumberDecoration(String wordName)

Check if the page number format has a decoration (eg. dash).

Parameters:

wordName - word page number format

Returns:

decoration type (one of the DECORATION_xxx constants).

getFldSimpleName

public static String getFldSimpleName(String instr)

convertDatePattern

public static String convertDatePattern(String wordDatePattern)

isAMPM

private static boolean isAMPM(String wordDatePattern,
 int idx)

appendDateItem

private static void appendDateItem(StringBuilder buffer,
 String dateItem)

formatDate

public static String formatDate(FldSimpleModel model)

formatDate

public static String formatDate(FldSimpleModel model,
 Date date)

formatDate

public static String formatDate(FldSimpleModel model,
 String format,
 Date date)

formatDate

private static String formatDate(FldSimpleModel model,
 String format,
 Date date,
 String lang)

hasSwitch

public static boolean hasSwitch(String switchDef,
 List<String> fldParameters)

findFirstSwitchValue

public static String findFirstSwitchValue(String switchDef,
 List<String> fldParameters,
 boolean ignoreMergeformat)

getSwitchValue

public static String getSwitchValue(int pos,
 List<String> fldParameters)

findAllSwitchValues

public static List<String> findAllSwitchValues(String switchDef,
 List<String> fldParameters)

findSwitch

public static int findSwitch(String switchDef,
 int startPos,
 List<String> fldParameters)

getSimpleDateFormat

private static SimpleDateFormat getSimpleDateFormat(String lang)

Parameters:

language - abbreviation like "fr-CA",

Returns:

SimpleDateFormat instance for specified language if null will @return SimpleDateFormat.getDateTimeInstance()