12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442 |
- /* ====================================================================
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-
- 2012 - Alfresco Software, Ltd.
- Alfresco Software has modified source of this file
- The details of changes as svn diff can be found in svn at location root/projects/3rd-party/src
- ==================================================================== */
- package org.apache.poi.ss.usermodel;
-
- import java.beans.PropertyChangeSupport;
- import java.math.BigDecimal;
- import java.math.RoundingMode;
- import java.text.DateFormat;
- import java.text.DateFormatSymbols;
- import java.text.DecimalFormat;
- import java.text.DecimalFormatSymbols;
- import java.text.FieldPosition;
- import java.text.Format;
- import java.text.ParsePosition;
- import java.text.SimpleDateFormat;
- import java.util.ArrayList;
- import java.util.Date;
- import java.util.HashMap;
- import java.util.List;
- import java.util.Locale;
- import java.util.Map;
- import java.util.regex.Matcher;
- import java.util.regex.Pattern;
-
- import org.apache.logging.log4j.LogManager;
- import org.apache.logging.log4j.Logger;
- import org.apache.poi.ss.format.CellFormat;
- import org.apache.poi.ss.format.CellFormatResult;
- import org.apache.poi.ss.formula.ConditionalFormattingEvaluator;
- import org.apache.poi.ss.util.DateFormatConverter;
- import org.apache.poi.ss.util.NumberToTextConverter;
- import org.apache.poi.util.LocaleUtil;
- import org.apache.poi.util.StringUtil;
-
-
- /**
- * DataFormatter contains methods for formatting the value stored in a
- * Cell. This can be useful for reports and GUI presentations when you
- * need to display data exactly as it appears in Excel. Supported formats
- * include currency, SSN, percentages, decimals, dates, phone numbers, zip
- * codes, etc.
- * <p>
- * Internally, formats will be implemented using subclasses of {@link Format}
- * such as {@link DecimalFormat} and {@link SimpleDateFormat}. Therefore the
- * formats used by this class must obey the same pattern rules as these Format
- * subclasses. This means that only legal number pattern characters ("0", "#",
- * ".", "," etc.) may appear in number formats. Other characters can be
- * inserted <em>before</em> or <em> after</em> the number pattern to form a
- * prefix or suffix.
- * </p>
- * <p>
- * For example the Excel pattern {@code "$#,##0.00 "USD"_);($#,##0.00 "USD")"
- * } will be correctly formatted as "$1,000.00 USD" or "($1,000.00 USD)".
- * However the pattern {@code "00-00-00"} is incorrectly formatted by
- * DecimalFormat as "000000--". For Excel formats that are not compatible with
- * DecimalFormat, you can provide your own custom {@link Format} implementation
- * via {@code DataFormatter.addFormat(String,Format)}. The following
- * custom formats are already provided by this class:
- * </p>
- * <pre>{@code
- * SSN "000-00-0000"
- * Phone Number "(###) ###-####"
- * Zip plus 4 "00000-0000"
- * }</pre>
- * <p>
- * If the Excel format pattern cannot be parsed successfully, then a default
- * format will be used. The default number format will mimic the Excel General
- * format: "#" for whole numbers and "#.##########" for decimal numbers. You
- * can override the default format pattern with {@code
- * DataFormatter.setDefaultNumberFormat(Format)}. <b>Note:</b> the
- * default format will only be used when a Format cannot be created from the
- * cell's data format string.
- *
- * <p>
- * Note that by default formatted numeric values are trimmed.
- * Excel formats can contain spacers and padding and the default behavior is to strip them off.
- * </p>
- * <p>Example:</p>
- * <p>
- * Consider a numeric cell with a value {@code 12.343} and format {@code "##.##_ "}.
- * The trailing underscore and space ("_ ") in the format adds a space to the end and Excel formats this cell as {@code "12.34 "},
- * but {@code DataFormatter} trims the formatted value and returns {@code "12.34"}.
- * </p>
- * You can enable spaces by passing the {@code emulateCSV=true} flag in the {@code DateFormatter} cosntructor.
- * If set to true, then the output tries to conform to what you get when you take an xls or xlsx in Excel and Save As CSV file:
- * <ul>
- * <li>returned values are not trimmed</li>
- * <li>Invalid dates are formatted as 255 pound signs ("#")</li>
- * <li>simulate Excel's handling of a format string of all # when the value is 0.
- * Excel will output "", {@code DataFormatter} will output "0".
- * </ul>
- * <p>
- * Some formats are automatically "localized" by Excel, eg show as mm/dd/yyyy when
- * loaded in Excel in some Locales but as dd/mm/yyyy in others. These are always
- * returned in the "default" (US) format, as stored in the file.
- * Some format strings request an alternate locale, eg
- * {@code [$-809]d/m/yy h:mm AM/PM} which explicitly requests UK locale.
- * These locale directives are (currently) ignored.
- * You can use {@link DateFormatConverter} to do some of this localisation if
- * you need it.
- */
- @SuppressWarnings("unused")
- public class DataFormatter {
- private static final String defaultFractionWholePartFormat = "#";
- private static final String defaultFractionFractionPartFormat = "#/##";
- /** Pattern to find a number format: "0" or "#" */
- private static final Pattern numPattern = Pattern.compile("[0#]+");
-
- /** Pattern to find days of week as text "ddd...." */
- private static final Pattern daysAsText = Pattern.compile("([d]{3,})", Pattern.CASE_INSENSITIVE);
-
- /** Pattern to find "AM/PM" marker */
- private static final Pattern amPmPattern = Pattern.compile("(([AP])[M/P]*)", Pattern.CASE_INSENSITIVE);
-
- /** Pattern to find formats with condition ranges e.g. [>=100] */
- private static final Pattern rangeConditionalPattern = Pattern.compile(".*\\[\\s*(>|>=|<|<=|=)\\s*[0-9]*\\.*[0-9].*");
-
- /**
- * A regex to find locale patterns like [$$-1009] and [$?-452].
- * Note that we don't currently process these into locales
- */
- private static final Pattern localePatternGroup = Pattern.compile("(\\[\\$[^-\\]]*-[0-9A-Z]+])");
-
- /**
- * A regex to match the colour formatting's rules.
- * Allowed colours are: Black, Blue, Cyan, Green,
- * Magenta, Red, White, Yellow, "Color n" (1<=n<=56)
- */
- private static final Pattern colorPattern =
- Pattern.compile("(\\[BLACK])|(\\[BLUE])|(\\[CYAN])|(\\[GREEN])|" +
- "(\\[MAGENTA])|(\\[RED])|(\\[WHITE])|(\\[YELLOW])|" +
- "(\\[COLOR\\s*\\d])|(\\[COLOR\\s*[0-5]\\d])", Pattern.CASE_INSENSITIVE);
-
- /**
- * A regex to identify a fraction pattern.
- * This requires that replaceAll("\\?", "#") has already been called
- */
- private static final Pattern fractionPattern = Pattern.compile("(?:([#\\d]+)\\s+)?(#+)\\s*/\\s*([#\\d]+)");
-
- /**
- * A regex to strip junk out of fraction formats
- */
- private static final Pattern fractionStripper = Pattern.compile("(\"[^\"]*\")|([^ ?#\\d/]+)");
-
- /**
- * A regex to detect if an alternate grouping character is used
- * in a numeric format
- */
- private static final Pattern alternateGrouping = Pattern.compile("([#0]([^.#0])[#0]{3})");
-
- /**
- * Cells formatted with a date or time format and which contain invalid date or time values
- * show 255 pound signs ("#").
- */
- private static final String invalidDateTimeString;
- static {
- StringBuilder buf = new StringBuilder();
- for(int i = 0; i < 255; i++) buf.append('#');
- invalidDateTimeString = buf.toString();
- }
-
- /**
- * The decimal symbols of the locale used for formatting values.
- */
- private DecimalFormatSymbols decimalSymbols;
-
- /**
- * The date symbols of the locale used for formatting values.
- */
- private DateFormatSymbols dateSymbols;
-
- /**
- * A default date format, if no date format was given
- */
- private DateFormat defaultDateformat;
-
- /** <em>General</em> format for numbers. */
- private Format generalNumberFormat;
-
- /** A default format to use when a number pattern cannot be parsed. */
- private Format defaultNumFormat;
-
- /**
- * A map to cache formats.
- * Map<String,Format> formats
- */
- private final Map<String,Format> formats = new HashMap<>();
-
- /** whether CSV friendly adjustments should be made to the formatted text **/
- private boolean emulateCSV = false;
-
- /** whether years in dates should be displayed with 4 digits even if the formatString specifies only 2 **/
- private boolean use4DigitYearsInAllDateFormats = false;
-
- /**
- * if set to true, avoid recalculating the values if there is a cached value available (default is false)
- */
- private boolean useCachedValuesForFormulaCells = false;
-
- /** stores the locale set by updateLocale method */
- private Locale locale;
-
- /** stores if the locale should change according to {@link LocaleUtil#getUserLocale()} */
- private boolean localeIsAdapting;
-
- // contain a support object instead of extending the support class
- private final PropertyChangeSupport pcs;
-
- /** For logging any problems we find */
- private static final Logger LOG = LogManager.getLogger(DataFormatter.class);
-
- /**
- * Creates a formatter using the {@link Locale#getDefault() default locale}.
- */
- public DataFormatter() {
- this(false);
- }
-
- /**
- * Creates a formatter using the {@link Locale#getDefault() default locale}.
- *
- * @param emulateCSV whether to emulate CSV output.
- */
- public DataFormatter(boolean emulateCSV) {
- this(LocaleUtil.getUserLocale(), true, emulateCSV);
- }
-
- /**
- * Creates a formatter using the given locale.
- */
- public DataFormatter(Locale locale) {
- this(locale, false);
- }
-
- /**
- * Creates a formatter using the given locale.
- *
- * @param emulateCSV whether to emulate CSV output.
- */
- public DataFormatter(Locale locale, boolean emulateCSV) {
- this(locale, false, emulateCSV);
- }
-
- /**
- * Creates a formatter using the given locale.
- * @param localeIsAdapting (true only if locale is not user-specified)
- * @param emulateCSV whether to emulate CSV output.
- */
- public DataFormatter(Locale locale, boolean localeIsAdapting, boolean emulateCSV) {
- this.localeIsAdapting = true;
- pcs = new PropertyChangeSupport(this);
- // localeIsAdapting must be true prior to this first checkForLocaleChange call.
- checkForLocaleChange(locale);
- // set localeIsAdapting so subsequent checks perform correctly
- // (whether a specific locale was provided to this DataFormatter or DataFormatter should
- // adapt to the current user locale as the locale changes)
- this.localeIsAdapting = localeIsAdapting;
- this.emulateCSV = emulateCSV;
- }
-
- /**
- * @param emulateCSV whether to emulate CSV output (default false).
- * @since POI 5.2.0
- */
- public void setEmulateCSV(boolean emulateCSV) {
- this.emulateCSV = emulateCSV;
- }
-
- /**
- * @return whether to emulate CSV output (default false).
- * @since POI 5.2.0
- */
- public boolean isEmulateCSV() {
- return emulateCSV;
- }
-
- /**
- * @param useCachedValuesForFormulaCells if set to true, when you do not provide a {@link FormulaEvaluator},
- * for cells with formulas, we will return the cached value for the cell (if available),
- * otherwise - we return the formula itself.
- * The default is false and this means we return the formula itself.
- * @since POI 5.2.0
- */
- public void setUseCachedValuesForFormulaCells(boolean useCachedValuesForFormulaCells) {
- this.useCachedValuesForFormulaCells = useCachedValuesForFormulaCells;
- }
-
- /**
- * @return useCachedValuesForFormulaCells if set to true, when you do not provide a {@link FormulaEvaluator},
- * for cells with formulas, we will return the cached value for the cell (if available),
- * otherwise - we return the formula itself.
- * The default is false and this means we return the formula itself.
- * @since POI 5.2.0
- */
- public boolean useCachedValuesForFormulaCells() {
- return useCachedValuesForFormulaCells;
- }
-
- /**
- * @param use4DigitYearsInAllDateFormats set to true if you want to have all dates formatted with 4 digit
- * years (even if the format associated with the cell specifies just 2)
- * @since POI 5.2.0
- */
- public void setUse4DigitYearsInAllDateFormats(boolean use4DigitYearsInAllDateFormats) {
- this.use4DigitYearsInAllDateFormats = use4DigitYearsInAllDateFormats;
- }
-
- /**
- * @return use4DigitYearsInAllDateFormats set to true if you want to have all dates formatted with 4 digit
- * years (even if the format associated with the cell specifies just 2)
- * @since POI 5.2.0
- */
- public boolean use4DigitYearsInAllDateFormats() {
- return use4DigitYearsInAllDateFormats;
- }
-
- /**
- * Return a Format for the given cell if one exists, otherwise try to
- * create one. This method will return {@code null} if any of the
- * following is true:
- * <ul>
- * <li>the cell's style is null</li>
- * <li>the style's data format string is null or empty</li>
- * <li>the format string cannot be recognized as either a number or date</li>
- * </ul>
- *
- * @param cell The cell to retrieve a Format for
- * @return A Format for the format String
- */
- private Format getFormat(Cell cell, ConditionalFormattingEvaluator cfEvaluator) {
- if (cell == null) return null;
-
- ExcelNumberFormat numFmt = ExcelNumberFormat.from(cell, cfEvaluator);
-
- if ( numFmt == null) {
- return null;
- }
-
- int formatIndex = numFmt.getIdx();
- String formatStr = numFmt.getFormat();
- if(StringUtil.isBlank(formatStr)) {
- return null;
- }
- return getFormat(cell.getNumericCellValue(), formatIndex, formatStr, isDate1904(cell));
- }
-
- private boolean isDate1904(Cell cell) {
- if ( cell != null && cell.getSheet().getWorkbook() instanceof Date1904Support) {
- return ((Date1904Support)cell.getSheet().getWorkbook()).isDate1904();
-
- }
- return false;
- }
-
- private Format getFormat(double cellValue, int formatIndex, String formatStrIn, boolean use1904Windowing) {
- if (formatStrIn == null) {
- throw new IllegalArgumentException("Missing input format for value " + cellValue + " and index " + formatIndex);
- }
-
- checkForLocaleChange();
-
- // Might be better to separate out the n p and z formats, falling back to p when n and z are not set.
- // That however would require other code to be re factored.
- // String[] formatBits = formatStrIn.split(";");
- // int i = cellValue > 0.0 ? 0 : cellValue < 0.0 ? 1 : 2;
- // String formatStr = (i < formatBits.length) ? formatBits[i] : formatBits[0];
-
- // this replace is done to fix https://bz.apache.org/bugzilla/show_bug.cgi?id=63211
- String formatStr = formatStrIn.replace("\\%", "\'%\'");
-
- // Excel supports 2+ part conditional data formats, eg positive/negative/zero,
- // or (>1000),(>0),(0),(negative). As Java doesn't handle these kinds
- // of different formats for different ranges, just +ve/-ve, we need to
- // handle these ourselves in a special way.
- // For now, if we detect 2+ parts, we call out to CellFormat to handle it
- // TODO Going forward, we should really merge the logic between the two classes
- if (formatStr.contains(";") &&
- (formatStr.indexOf(';') != formatStr.lastIndexOf(';')
- || rangeConditionalPattern.matcher(formatStr).matches()
- ) ) {
- try {
- // Ask CellFormat to get a formatter for it
- CellFormat cfmt = CellFormat.getInstance(locale, formatStr);
- // CellFormat requires callers to identify date vs not, so do so
- // don't try to handle Date value 0, let a 3 or 4-part format take care of it
- Object cellValueO = (cellValue != 0.0 && DateUtil.isADateFormat(formatIndex, formatStr))
- ? DateUtil.getJavaDate(cellValue, use1904Windowing)
- : cellValue;
- // Wrap and return (non-cacheable - CellFormat does that)
- return new CellFormatResultWrapper( cfmt.apply(cellValueO) );
- } catch (Exception e) {
- LOG.atWarn().withThrowable(e).log("Formatting failed for format {}, falling back", formatStr);
- }
- }
-
- // Excel's # with value 0 will output empty where Java will output 0. This hack removes the # from the format.
- if (emulateCSV && cellValue == 0.0 && formatStr.contains("#") && !formatStr.contains("0")) {
- formatStr = formatStr.replace("#", "");
- }
-
- // See if we already have it cached
- Format format = formats.get(formatStr);
- if (format != null) {
- return format;
- }
-
- // Is it one of the special built in types, General or @?
- if ("General".equalsIgnoreCase(formatStr) || "@".equals(formatStr)) {
- return generalNumberFormat;
- }
-
- // Build a formatter, and cache it
- format = createFormat(cellValue, formatIndex, formatStr);
- formats.put(formatStr, format);
- return format;
- }
-
- /**
- * Create and return a Format based on the format string from a cell's
- * style. If the pattern cannot be parsed, return a default pattern.
- *
- * @param cell The Excel cell
- * @return A Format representing the excel format. May return null.
- */
- public Format createFormat(Cell cell) {
-
- int formatIndex = cell.getCellStyle().getDataFormat();
- String formatStr = cell.getCellStyle().getDataFormatString();
- return createFormat(cell.getNumericCellValue(), formatIndex, formatStr);
- }
-
- private Format createFormat(double cellValue, int formatIndex, String sFormat) {
- checkForLocaleChange();
-
- String formatStr = sFormat;
-
- // Remove colour formatting if present
- if (formatStr != null) {
- Matcher colourM = colorPattern.matcher(formatStr);
- while (colourM.find()) {
- String colour = colourM.group();
-
- // Paranoid replacement...
- int at = formatStr.indexOf(colour);
- if (at == -1) break;
- String nFormatStr = formatStr.substring(0, at) +
- formatStr.substring(at + colour.length());
- if (nFormatStr.equals(formatStr)) break;
-
- // Try again in case there's multiple
- formatStr = nFormatStr;
- colourM = colorPattern.matcher(formatStr);
- }
- }
-
- // Strip off the locale information, we use an instance-wide locale for everything
- if (formatStr != null) {
- Matcher m = localePatternGroup.matcher(formatStr);
- while (m.find()) {
- String match = m.group();
- String symbol = match.substring(match.indexOf('$') + 1, match.indexOf('-'));
- if (symbol.indexOf('$') > -1) {
- symbol = symbol.substring(0, symbol.indexOf('$')) +
- '\\' +
- symbol.substring(symbol.indexOf('$'));
- }
- formatStr = m.replaceAll(symbol);
- m = localePatternGroup.matcher(formatStr);
- }
- }
-
- // Check for special cases
- if(StringUtil.isBlank(formatStr)) {
- return getDefaultFormat(cellValue);
- }
-
- if ("General".equalsIgnoreCase(formatStr) || "@".equals(formatStr)) {
- return generalNumberFormat;
- }
-
- if(DateUtil.isADateFormat(formatIndex,formatStr) &&
- DateUtil.isValidExcelDate(cellValue)) {
- return createDateFormat(formatStr, cellValue);
- }
- // Excel supports fractions in format strings, which Java doesn't
- if (formatStr.contains("#/") || formatStr.contains("?/")) {
- String[] chunks = formatStr.split(";");
- for (String chunk1 : chunks) {
- String chunk = chunk1.replace("?", "#");
- Matcher matcher = fractionStripper.matcher(chunk);
- chunk = matcher.replaceAll(" ");
- chunk = chunk.replaceAll(" +", " ");
- Matcher fractionMatcher = fractionPattern.matcher(chunk);
- //take the first match
- if (fractionMatcher.find()) {
- String wholePart = (fractionMatcher.group(1) == null) ? "" : defaultFractionWholePartFormat;
- return new FractionFormat(wholePart, fractionMatcher.group(3));
- }
- }
-
- // Strip custom text in quotes and escaped characters for now as it can cause performance problems in fractions.
- //String strippedFormatStr = formatStr.replaceAll("\\\\ ", " ").replaceAll("\\\\.", "").replaceAll("\"[^\"]*\"", " ").replaceAll("\\?", "#");
- return new FractionFormat(defaultFractionWholePartFormat, defaultFractionFractionPartFormat);
- }
-
- if (numPattern.matcher(formatStr).find()) {
- return createNumberFormat(formatStr, cellValue);
- }
-
- if (emulateCSV) {
- return new ConstantStringFormat(cleanFormatForNumber(formatStr));
- }
- // TODO - when does this occur?
- return null;
- }
-
- String adjustTo4DigitYearsIfConfigured(String format) {
- if (use4DigitYearsInAllDateFormats) {
- int ypos2 = format.indexOf("yy");
- if (ypos2 < 0) {
- return format;
- } else {
- int ypos3 = format.indexOf("yyy");
- int ypos4 = format.indexOf("yyyy");
- if (ypos4 == ypos2) {
- String part1 = format.substring(0, ypos2 + 4);
- String part2 = format.substring(ypos2 + 4);
- return part1 + adjustTo4DigitYearsIfConfigured(part2);
- } else if (ypos3 == ypos2) {
- return format;
- } else {
- String part1 = format.substring(0, ypos2 + 2);
- String part2 = format.substring(ypos2 + 2);
- return part1 + "yy" + adjustTo4DigitYearsIfConfigured(part2);
- }
- }
- }
- return format;
- }
-
- private Format createDateFormat(String pFormatStr, double cellValue) {
- String formatStr = adjustTo4DigitYearsIfConfigured(pFormatStr);
- formatStr = formatStr.replace("\\-","-");
- formatStr = formatStr.replace("\\,",",");
- formatStr = formatStr.replace("\\.","."); // . is a special regexp char
- formatStr = formatStr.replace("\\ "," ");
- formatStr = formatStr.replace("\\/","/"); // weird: m\\/d\\/yyyy
- formatStr = formatStr.replace(";@", "");
- formatStr = formatStr.replace("\"/\"", "/"); // "/" is escaped for no reason in: mm"/"dd"/"yyyy
- formatStr = formatStr.replace("\"\"", "'"); // replace Excel quoting with Java style quoting
- formatStr = formatStr.replace("\\T","'T'"); // Quote the T is iso8601 style dates
-
-
- boolean hasAmPm = false;
- Matcher amPmMatcher = amPmPattern.matcher(formatStr);
- while (amPmMatcher.find()) {
- formatStr = amPmMatcher.replaceAll("@");
- hasAmPm = true;
- amPmMatcher = amPmPattern.matcher(formatStr);
- }
- formatStr = formatStr.replace('@', 'a');
-
-
- Matcher dateMatcher = daysAsText.matcher(formatStr);
- if (dateMatcher.find()) {
- String match = dateMatcher.group(0).toUpperCase(Locale.ROOT).replace('D', 'E');
- formatStr = dateMatcher.replaceAll(match);
- }
-
- // Convert excel date format to SimpleDateFormat.
- // Excel uses lower and upper case 'm' for both minutes and months.
- // From Excel help:
- /*
- The "m" or "mm" code must appear immediately after the "h" or"hh"
- code or immediately before the "ss" code; otherwise, Microsoft
- Excel displays the month instead of minutes."
- */
-
- StringBuilder sb = new StringBuilder();
- char[] chars = formatStr.toCharArray();
- boolean mIsMonth = true;
- List<Integer> ms = new ArrayList<>();
- boolean isElapsed = false;
- for(int j=0; j<chars.length; j++) {
- char c = chars[j];
- if (c == '\'') {
- sb.append(c);
- j++;
-
- // skip until the next quote
- while(j<chars.length) {
- c = chars[j];
- sb.append(c);
- if(c == '\'') {
- break;
- }
- j++;
- }
- }
- else if (c == '[' && !isElapsed) {
- isElapsed = true;
- mIsMonth = false;
- sb.append(c);
- }
- else if (c == ']' && isElapsed) {
- isElapsed = false;
- sb.append(c);
- }
- else if (isElapsed) {
- if (c == 'h' || c == 'H') {
- sb.append('H');
- }
- else if (c == 'm' || c == 'M') {
- sb.append('m');
- }
- else if (c == 's' || c == 'S') {
- sb.append('s');
- }
- else {
- sb.append(c);
- }
- }
- else if (c == 'h' || c == 'H') {
- mIsMonth = false;
- if (hasAmPm) {
- sb.append('h');
- } else {
- sb.append('H');
- }
- }
- else if (c == 'm' || c == 'M') {
- if(mIsMonth) {
- sb.append('M');
- ms.add(sb.length() - 1);
- } else {
- sb.append('m');
- }
- }
- else if (c == 's' || c == 'S') {
- sb.append('s');
- // if 'M' precedes 's' it should be minutes ('m')
- for (int index : ms) {
- if (sb.charAt(index) == 'M') {
- sb.replace(index, index + 1, "m");
- }
- }
- mIsMonth = true;
- ms.clear();
- }
- else if (Character.isLetter(c)) {
- mIsMonth = true;
- ms.clear();
- if (c == 'y' || c == 'Y') {
- sb.append('y');
- }
- else if (c == 'd' || c == 'D') {
- sb.append('d');
- }
- else {
- sb.append(c);
- }
- }
- else {
- if (Character.isWhitespace(c)){
- ms.clear();
- }
- sb.append(c);
- }
- }
- formatStr = sb.toString();
-
- try {
- return new ExcelStyleDateFormatter(formatStr, dateSymbols);
- } catch(IllegalArgumentException iae) {
- LOG.atDebug().withThrowable(iae).log("Formatting failed for format {}, falling back", formatStr);
- // the pattern could not be parsed correctly,
- // so fall back to the default number format
- return getDefaultFormat(cellValue);
- }
-
- }
-
- private String cleanFormatForNumber(String formatStrIn) {
- // this replace is done to fix https://bz.apache.org/bugzilla/show_bug.cgi?id=63211
- String formatStr = formatStrIn.replace("\\%", "\'%\'");
-
- StringBuilder sb = new StringBuilder(formatStr);
-
- if (emulateCSV) {
- // Requested spacers with "_" are replaced by a single space.
- // Full-column-width padding "*" are removed.
- // Not processing fractions at this time. Replace ? with space.
- // This matches CSV output.
- for (int i = 0; i < sb.length(); i++) {
- char c = sb.charAt(i);
- if (c == '_' || c == '*' || c == '?') {
- if (i > 0 && sb.charAt((i - 1)) == '\\') {
- // It's escaped, don't worry
- continue;
- }
- if (c == '?') {
- sb.setCharAt(i, ' ');
- } else if (i < sb.length() - 1) {
- // Remove the character we're supposed
- // to match the space of / pad to the
- // column width with
- if (c == '_') {
- sb.setCharAt(i + 1, ' ');
- } else {
- sb.deleteCharAt(i + 1);
- }
- // Remove the character too
- sb.deleteCharAt(i);
- i--;
- }
- }
- }
- } else {
- // If they requested spacers, with "_",
- // remove those as we don't do spacing
- // If they requested full-column-width
- // padding, with "*", remove those too
- for (int i = 0; i < sb.length(); i++) {
- char c = sb.charAt(i);
- if (c == '_' || c == '*') {
- if (i > 0 && sb.charAt((i - 1)) == '\\') {
- // It's escaped, don't worry
- continue;
- }
- if (i < sb.length() - 1) {
- // Remove the character we're supposed
- // to match the space of / pad to the
- // column width with
- sb.deleteCharAt(i + 1);
- }
- // Remove the _ too
- sb.deleteCharAt(i);
- i--;
- }
- }
- }
-
- // Now, handle the other aspects like
- // quoting and scientific notation
- for(int i = 0; i < sb.length(); i++) {
- char c = sb.charAt(i);
- // remove quotes and back slashes
- if (c == '\\' || c == '"') {
- sb.deleteCharAt(i);
- i--;
-
- // for scientific/engineering notation
- } else if ((c == '+' || c == '-') && i > 0 && sb.charAt(i - 1) == 'E') {
- sb.deleteCharAt(i);
- i--;
- }
- }
-
- return sb.toString();
- }
-
- private static class InternalDecimalFormatWithScale extends Format {
-
- private static final Pattern endsWithCommas = Pattern.compile("(,+)$");
- private final BigDecimal divider;
- private static final BigDecimal ONE_THOUSAND = BigDecimal.valueOf(1000);
- private final DecimalFormat df;
- private static String trimTrailingCommas(String s) {
- return s.replaceAll(",+$", "");
- }
-
- public InternalDecimalFormatWithScale(String pattern, DecimalFormatSymbols symbols) {
- df = new DecimalFormat(trimTrailingCommas(pattern), symbols);
- setExcelStyleRoundingMode(df);
- Matcher endsWithCommasMatcher = endsWithCommas.matcher(pattern);
- if (endsWithCommasMatcher.find()) {
- String commas = (endsWithCommasMatcher.group(1));
- BigDecimal temp = BigDecimal.ONE;
- for (int i = 0; i < commas.length(); ++i) {
- temp = temp.multiply(ONE_THOUSAND);
- }
- divider = temp;
- } else {
- divider = null;
- }
- }
-
- private Object scaleInput(Object obj) {
- if (divider != null) {
- if (obj instanceof BigDecimal) {
- obj = ((BigDecimal) obj).divide(divider, RoundingMode.HALF_UP);
- } else if (obj instanceof Double) {
- obj = (Double) obj / divider.doubleValue();
- } else {
- throw new UnsupportedOperationException();
- }
- }
- return obj;
- }
-
- @Override
- public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos) {
- obj = scaleInput(obj);
- return df.format(obj, toAppendTo, pos);
- }
-
- @Override
- public Object parseObject(String source, ParsePosition pos) {
- throw new UnsupportedOperationException();
- }
- }
-
- private Format createNumberFormat(String formatStr, double cellValue) {
- String format = cleanFormatForNumber(formatStr);
- DecimalFormatSymbols symbols = decimalSymbols;
-
- // Do we need to change the grouping character?
- // eg for a format like #'##0 which wants 12'345 not 12,345
- Matcher agm = alternateGrouping.matcher(format);
- if (agm.find()) {
- char grouping = agm.group(2).charAt(0);
- // Only replace the grouping character if it is not the default
- // grouping character for the US locale (',') in order to enable
- // correct grouping for non-US locales.
- if (grouping!=',') {
- symbols = DecimalFormatSymbols.getInstance(locale);
-
- symbols.setGroupingSeparator(grouping);
- String oldPart = agm.group(1);
- String newPart = oldPart.replace(grouping, ',');
- format = format.replace(oldPart, newPart);
- }
- }
-
- try {
- return new InternalDecimalFormatWithScale(format, symbols);
- } catch(IllegalArgumentException iae) {
- LOG.atDebug().withThrowable(iae).log("Formatting failed for format {}, falling back", formatStr);
- // the pattern could not be parsed correctly,
- // so fall back to the default number format
- return getDefaultFormat(cellValue);
- }
- }
-
- /**
- * Returns a default format for a cell.
- * @param cell The cell
- * @return a default format
- */
- public Format getDefaultFormat(Cell cell) {
- return getDefaultFormat(cell.getNumericCellValue());
- }
- private Format getDefaultFormat(double cellValue) {
- checkForLocaleChange();
-
- // for numeric cells try user supplied default
- if (defaultNumFormat != null) {
- return defaultNumFormat;
-
- // otherwise use general format
- }
- return generalNumberFormat;
- }
-
- /**
- * Performs Excel-style date formatting, using the
- * supplied Date and format
- */
- @SuppressWarnings("SynchronizationOnLocalVariableOrMethodParameter")
- private String performDateFormatting(Date d, Format dateFormat) {
- Format df = dateFormat != null ? dateFormat : defaultDateformat;
- synchronized (df) {
- return df.format(d);
- }
- }
-
- /**
- * Returns the formatted value of an Excel date as a {@code String} based
- * on the cell's {@code DataFormat}. i.e. "Thursday, January 02, 2003"
- * , "01/02/2003" , "02-Jan" , etc.
- * <p>
- * If any conditional format rules apply, the highest priority with a number format is used.
- * If no rules contain a number format, or no rules apply, the cell's style format is used.
- * If the style does not have a format, the default date format is applied.
- *
- * @param cell to format
- * @param cfEvaluator ConditionalFormattingEvaluator (if available)
- * @return Formatted value
- */
- @SuppressWarnings("SynchronizationOnLocalVariableOrMethodParameter")
- private String getFormattedDateString(Cell cell, ConditionalFormattingEvaluator cfEvaluator) {
- if (cell == null) {
- return null;
- }
- Format dateFormat = getFormat(cell, cfEvaluator);
- if (dateFormat == null) {
- if (defaultDateformat == null) {
- DateFormatSymbols sym = DateFormatSymbols.getInstance(LocaleUtil.getUserLocale());
- SimpleDateFormat sdf = new SimpleDateFormat("EEE MMM dd HH:mm:ss zzz yyyy", sym);
- sdf.setTimeZone(LocaleUtil.getUserTimeZone());
- dateFormat = sdf;
- } else {
- dateFormat = defaultNumFormat;
- }
- }
- synchronized (dateFormat) {
- if(dateFormat instanceof ExcelStyleDateFormatter) {
- // Hint about the raw excel value
- ((ExcelStyleDateFormatter)dateFormat).setDateToBeFormatted(
- cell.getNumericCellValue()
- );
- }
- Date d = cell.getDateCellValue();
- return performDateFormatting(d, dateFormat);
- }
- }
-
- /**
- * Returns the formatted value of an Excel number as a {@code String}
- * based on the cell's {@code DataFormat}. Supported formats include
- * currency, percents, decimals, phone number, SSN, etc.:
- * "61.54%", "$100.00", "(800) 555-1234".
- * <p>
- * Format comes from either the highest priority conditional format rule with a
- * specified format, or from the cell style.
- *
- * @param cell The cell
- * @param cfEvaluator if available, or null
- * @return a formatted number string
- */
- private String getFormattedNumberString(Cell cell, ConditionalFormattingEvaluator cfEvaluator) {
- if (cell == null) {
- return null;
- }
- Format numberFormat = getFormat(cell, cfEvaluator);
- double d = cell.getNumericCellValue();
- if (numberFormat == null) {
- return Double.toString(d);
- }
- String formatted;
- try {
- //see https://github.com/apache/poi/pull/321 -- but this sometimes fails, thus the catch and retry
- formatted = numberFormat.format(BigDecimal.valueOf(d));
- } catch (NumberFormatException nfe) {
- formatted = numberFormat.format(d);
- }
- return formatted.replaceFirst("E(\\d)", "E+$1"); // to match Excel's E-notation
- }
-
- /**
- * Formats the given raw cell value, based on the supplied
- * format index and string, according to excel style rules.
- * @see #formatCellValue(Cell)
- */
- public String formatRawCellContents(double value, int formatIndex, String formatString) {
- return formatRawCellContents(value, formatIndex, formatString, false);
- }
- /**
- * Formats the given raw cell value, based on the supplied
- * format index and string, according to excel style rules.
- * @see #formatCellValue(Cell)
- */
- public String formatRawCellContents(double value, int formatIndex, String formatString, boolean use1904Windowing) {
- checkForLocaleChange();
-
- // Is it a date?
- if(DateUtil.isADateFormat(formatIndex,formatString)) {
- if(DateUtil.isValidExcelDate(value)) {
- Format dateFormat = getFormat(value, formatIndex, formatString, use1904Windowing);
- if(dateFormat instanceof ExcelStyleDateFormatter) {
- // Hint about the raw excel value
- ((ExcelStyleDateFormatter)dateFormat).setDateToBeFormatted(value);
- }
- Date d = DateUtil.getJavaDate(value, use1904Windowing);
- return performDateFormatting(d, dateFormat);
- }
- // RK: Invalid dates are 255 #s.
- if (emulateCSV) {
- return invalidDateTimeString;
- }
- }
-
- // else Number
- Format numberFormat = getFormat(value, formatIndex, formatString, use1904Windowing);
- if (numberFormat == null) {
- return String.valueOf(value);
- }
-
- // When formatting 'value', double to text to BigDecimal produces more
- // accurate results than double to Double in JDK8 (as compared to
- // previous versions). However, if the value contains E notation, this
- // would expand the values, which we do not want, so revert to
- // original method.
- String result;
- final String textValue = NumberToTextConverter.toText(value);
- if (textValue.indexOf('E') > -1) {
- result = numberFormat.format(value);
- }
- else {
- result = numberFormat.format(new BigDecimal(textValue));
- }
-
- // If they requested a non-abbreviated Scientific format,
- // and there's an E## (but not E-##), add the missing '+' for E+##
- String fslc = formatString.toLowerCase(Locale.ROOT);
- if ((fslc.contains("general") || fslc.contains("e+0"))
- && result.contains("E") && !result.contains("E-")) {
- result = result.replaceFirst("E", "E+");
- }
- return result;
- }
-
- /**
- * <p>
- * Returns the formatted value of a cell as a {@code String} regardless
- * of the cell type. If the Excel format pattern cannot be parsed then the
- * cell value will be formatted using a default format.
- * </p>
- * <p>When passed a null or blank cell, this method will return an empty
- * String (""). Formulas in formula type cells will not be evaluated.
- * {@link #setUseCachedValuesForFormulaCells} controls how these cells are evaluated.
- * </p>
- *
- * @param cell The cell
- * @return the formatted cell value as a String
- * @see #setUseCachedValuesForFormulaCells(boolean)
- * @see #formatCellValue(Cell, FormulaEvaluator)
- * @see #formatCellValue(Cell, FormulaEvaluator, ConditionalFormattingEvaluator)
- */
- public String formatCellValue(Cell cell) {
- return formatCellValue(cell, null);
- }
-
- /**
- * <p>
- * Returns the formatted value of a cell as a {@code String} regardless
- * of the cell type. If the Excel number format pattern cannot be parsed then the
- * cell value will be formatted using a default format.
- * </p>
- * <p>When passed a null or blank cell, this method will return an empty
- * String (""). Formula cells will be evaluated using the given
- * {@link FormulaEvaluator} if the evaluator is non-null. If the
- * evaluator is null, then the formula String will be returned. The caller
- * is responsible for setting the currentRow on the evaluator.
- *</p>
- *
- * @param cell The cell (can be null)
- * @param evaluator The FormulaEvaluator (can be null)
- * @return a string value of the cell
- * @see #formatCellValue(Cell)
- * @see #formatCellValue(Cell, FormulaEvaluator, ConditionalFormattingEvaluator)
- */
- public String formatCellValue(Cell cell, FormulaEvaluator evaluator) {
- return formatCellValue(cell, evaluator, null);
- }
-
- /**
- * <p>
- * Returns the formatted value of a cell as a {@code String} regardless
- * of the cell type. If the Excel number format pattern cannot be parsed then the
- * cell value will be formatted using a default format.
- * </p>
- * <p>When passed a null or blank cell, this method will return an empty
- * String (""). Formula cells will be evaluated using the given
- * {@link FormulaEvaluator} if the evaluator is non-null. If the
- * evaluator is null, then the formula String will be returned. The caller
- * is responsible for setting the currentRow on the evaluator
- *</p>
- * <p>
- * When a ConditionalFormattingEvaluator is present, it is checked first to see
- * if there is a number format to apply. If multiple rules apply, the last one is used.
- * If no ConditionalFormattingEvaluator is present, no rules apply, or the applied
- * rules do not define a format, the cell's style format is used.
- * </p>
- * <p>
- * The two evaluators should be from the same context, to avoid inconsistencies in cached values.
- *</p>
- *
- * @param cell The cell (can be null)
- * @param evaluator The FormulaEvaluator (can be null)
- * @param cfEvaluator ConditionalFormattingEvaluator (can be null)
- * @return a string value of the cell
- * @see #formatCellValue(Cell)
- * @see #formatCellValue(Cell, FormulaEvaluator)
- */
- public String formatCellValue(Cell cell, FormulaEvaluator evaluator, ConditionalFormattingEvaluator cfEvaluator) {
- checkForLocaleChange();
-
- if (cell == null) {
- return "";
- }
-
- CellType cellType = cell.getCellType();
- if (cellType == CellType.FORMULA) {
- if (evaluator == null) {
- if (useCachedValuesForFormulaCells) {
- try {
- cellType = cell.getCachedFormulaResultType();
- } catch (Exception e) {
- return cell.getCellFormula();
- }
- } else {
- return cell.getCellFormula();
- }
- } else {
- cellType = evaluator.evaluateFormulaCell(cell);
- }
- }
- switch (cellType) {
- case NUMERIC :
-
- if (DateUtil.isCellDateFormatted(cell, cfEvaluator)) {
- return getFormattedDateString(cell, cfEvaluator);
- }
- return getFormattedNumberString(cell, cfEvaluator);
-
- case STRING :
- return cell.getRichStringCellValue().getString();
-
- case BOOLEAN :
- return cell.getBooleanCellValue() ? "TRUE" : "FALSE";
- case BLANK :
- return "";
- case ERROR:
- return FormulaError.forInt(cell.getErrorCellValue()).getString();
- default:
- throw new IllegalStateException("Unexpected celltype (" + cellType + ")");
- }
- }
-
-
- /**
- * <p>
- * Sets a default number format to be used when the Excel format cannot be
- * parsed successfully. <b>Note:</b> This is a fall back for when an error
- * occurs while parsing an Excel number format pattern. This will not
- * affect cells with the <em>General</em> format.
- * </p>
- * <p>
- * The value that will be passed to the Format's format method (specified
- * by {@code java.text.Format#format}) will be a double value from a
- * numeric cell. Therefore the code in the format method should expect a
- * {@code Number} value.
- * </p>
- *
- * @param format A Format instance to be used as a default
- * @see Format#format
- */
- public void setDefaultNumberFormat(Format format) {
- for (Map.Entry<String, Format> entry : formats.entrySet()) {
- if (entry.getValue() == generalNumberFormat) {
- entry.setValue(format);
- }
- }
- defaultNumFormat = format;
- }
-
- /**
- * Adds a new format to the available formats.
- * <p>
- * The value that will be passed to the Format's format method (specified
- * by {@code java.text.Format#format}) will be a double value from a
- * numeric cell. Therefore the code in the format method should expect a
- * {@code Number} value.
- * </p>
- * @param excelFormatStr The data format string
- * @param format A Format instance
- */
- public void addFormat(String excelFormatStr, Format format) {
- formats.put(excelFormatStr, format);
- }
-
- // Some custom formats
-
- /**
- * @return a {@code DecimalFormat} with parseIntegerOnly set {@code true}
- */
- private static DecimalFormat createIntegerOnlyFormat(String fmt) {
- DecimalFormatSymbols dsf = DecimalFormatSymbols.getInstance(Locale.ROOT);
- DecimalFormat result = new DecimalFormat(fmt, dsf);
- result.setParseIntegerOnly(true);
- return result;
- }
-
- /**
- * Enables excel style rounding mode (round half up) on the
- * Decimal Format given.
- */
- public static void setExcelStyleRoundingMode(DecimalFormat format) {
- setExcelStyleRoundingMode(format, RoundingMode.HALF_UP);
- }
-
- /**
- * Enables custom rounding mode on the given Decimal Format.
- * @param format DecimalFormat
- * @param roundingMode RoundingMode
- */
- public static void setExcelStyleRoundingMode(DecimalFormat format, RoundingMode roundingMode) {
- format.setRoundingMode(roundingMode);
- }
-
- /**
- * If the Locale has been changed via {@link LocaleUtil#setUserLocale(Locale)} the stored
- * formats need to be refreshed. All formats which aren't originated from DataFormatter
- * itself, i.e. all Formats added via {@link DataFormatter#addFormat(String, Format)} and
- * {@link DataFormatter#setDefaultNumberFormat(Format)}, need to be added again.
- * To notify callers, the returned {@link PropertyChangeSupport} should be used.
- * The Locale in {@link #updateLocale(Locale)} is the new Locale.
- *
- * @return the listener object, where callers can register themselves
- */
- public PropertyChangeSupport getLocaleChangedObservable() {
- return pcs;
- }
-
- private void checkForLocaleChange() {
- checkForLocaleChange(LocaleUtil.getUserLocale());
- }
-
- private void checkForLocaleChange(Locale newLocale) {
- if (!localeIsAdapting) return;
- if (newLocale.equals(locale)) return;
- updateLocale(newLocale);
- pcs.firePropertyChange("locale", locale, newLocale);
- }
-
- /**
- * Update formats when locale has been changed
- *
- * @param newLocale the new locale
- */
- public void updateLocale(Locale newLocale) {
- if (!localeIsAdapting || newLocale.equals(locale)) return;
-
- locale = newLocale;
-
- dateSymbols = DateFormatSymbols.getInstance(locale);
- decimalSymbols = DecimalFormatSymbols.getInstance(locale);
- generalNumberFormat = new ExcelGeneralNumberFormat(locale);
-
- // taken from Date.toString()
- defaultDateformat = new SimpleDateFormat("EEE MMM dd HH:mm:ss zzz yyyy", dateSymbols);
- defaultDateformat.setTimeZone(LocaleUtil.getUserTimeZone());
-
- // init built-in formats
-
- formats.clear();
- Format zipFormat = ZipPlusFourFormat.instance;
- addFormat("00000\\-0000", zipFormat);
- addFormat("00000-0000", zipFormat);
-
- Format phoneFormat = PhoneFormat.instance;
- // allow for format string variations
- addFormat("[<=9999999]###\\-####;\\(###\\)\\ ###\\-####", phoneFormat);
- addFormat("[<=9999999]###-####;(###) ###-####", phoneFormat);
- addFormat("###\\-####;\\(###\\)\\ ###\\-####", phoneFormat);
- addFormat("###-####;(###) ###-####", phoneFormat);
-
- Format ssnFormat = SSNFormat.instance;
- addFormat("000\\-00\\-0000", ssnFormat);
- addFormat("000-00-0000", ssnFormat);
- }
-
- /**
- * Format class for Excel's SSN format. This class mimics Excel's built-in
- * SSN formatting.
- */
- @SuppressWarnings("serial")
- private static final class SSNFormat extends Format {
- public static final Format instance = new SSNFormat();
- private static final DecimalFormat df = createIntegerOnlyFormat("000000000");
- private SSNFormat() {
- // enforce singleton
- }
-
- /** Format a number as an SSN */
- public static String format(Number num) {
- String result = df.format(num);
- return result.substring(0, 3) + '-' +
- result.substring(3, 5) + '-' +
- result.substring(5, 9);
- }
-
- @Override
- public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos) {
- return toAppendTo.append(format((Number)obj));
- }
-
- @Override
- public Object parseObject(String source, ParsePosition pos) {
- return df.parseObject(source, pos);
- }
- }
-
- /**
- * Format class for Excel Zip + 4 format. This class mimics Excel's
- * built-in formatting for Zip + 4.
- */
- @SuppressWarnings("serial")
- private static final class ZipPlusFourFormat extends Format {
- public static final Format instance = new ZipPlusFourFormat();
- private static final DecimalFormat df = createIntegerOnlyFormat("000000000");
- private ZipPlusFourFormat() {
- // enforce singleton
- }
-
- /** Format a number as Zip + 4 */
- public static String format(Number num) {
- String result = df.format(num);
- return result.substring(0, 5) + '-' +
- result.substring(5, 9);
- }
-
- @Override
- public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos) {
- return toAppendTo.append(format((Number)obj));
- }
-
- @Override
- public Object parseObject(String source, ParsePosition pos) {
- return df.parseObject(source, pos);
- }
- }
-
- /**
- * Format class for Excel phone number format. This class mimics Excel's
- * built-in phone number formatting.
- */
- @SuppressWarnings("serial")
- private static final class PhoneFormat extends Format {
- public static final Format instance = new PhoneFormat();
- private static final DecimalFormat df = createIntegerOnlyFormat("##########");
- private PhoneFormat() {
- // enforce singleton
- }
-
- /** Format a number as a phone number */
- public static String format(Number num) {
- String result = df.format(num);
- StringBuilder sb = new StringBuilder();
- String seg1, seg2, seg3;
- int len = result.length();
- if (len <= 4) {
- return result;
- }
-
- seg3 = result.substring(len - 4, len);
- seg2 = result.substring(Math.max(0, len - 7), len - 4);
- seg1 = result.substring(Math.max(0, len - 10), Math.max(0, len - 7));
-
- if(StringUtil.isNotBlank(seg1)) {
- sb.append('(').append(seg1).append(") ");
- }
- if(StringUtil.isNotBlank(seg2)) {
- sb.append(seg2).append('-');
- }
- sb.append(seg3);
- return sb.toString();
- }
-
- @Override
- public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos) {
- return toAppendTo.append(format((Number)obj));
- }
-
- @Override
- public Object parseObject(String source, ParsePosition pos) {
- return df.parseObject(source, pos);
- }
- }
-
-
-
-
- /**
- * Format class that does nothing and always returns a constant string.
- *
- * This format is used to simulate Excel's handling of a format string
- * of all # when the value is 0. Excel will output "", Java will output "0".
- *
- * @see DataFormatter#createFormat(double, int, String)
- */
- @SuppressWarnings("serial")
- private static final class ConstantStringFormat extends Format {
- private static final DecimalFormat df = createIntegerOnlyFormat("##########");
- private final String str;
- public ConstantStringFormat(String s) {
- str = s;
- }
-
- @Override
- public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos) {
- return toAppendTo.append(str);
- }
-
- @Override
- public Object parseObject(String source, ParsePosition pos) {
- return df.parseObject(source, pos);
- }
- }
- /**
- * Workaround until we merge {@link DataFormatter} with {@link CellFormat}.
- * Constant, non-cachable wrapper around a {@link CellFormatResult}
- */
- @SuppressWarnings("serial")
- private final class CellFormatResultWrapper extends Format {
- private final CellFormatResult result;
- private CellFormatResultWrapper(CellFormatResult result) {
- this.result = result;
- }
- @Override
- public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos) {
- if (emulateCSV) {
- return toAppendTo.append(result.text);
- } else {
- return toAppendTo.append(result.text.trim());
- }
- }
- @Override
- public Object parseObject(String source, ParsePosition pos) {
- return null; // Not supported
- }
- }
- }
|