hssfdataformatter.java

来自「EXCEL read and write」· Java 代码 · 共 684 行 · 第 1/2 页

/* ====================================================================
   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.
==================================================================== */

package org.apache.poi.hssf.usermodel;

import java.text.DecimalFormat;
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.Iterator;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * HSSFDataFormatter contains methods for formatting the value stored in an
 * HSSFCell. 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")"
 * </code> will be correctly formatted as "$1,000.00 USD" or "($1,000.00 USD)".
 * However the pattern <code>"00-00-00"</code> 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>HSSFDataFormatter.addFormat(String,Format)</code>. The following
 * custom formats are already provided by this class:
 * </p>
 * <pre>
 * <ul><li>SSN "000-00-0000"</li>
 *     <li>Phone Number "(###) ###-####"</li>
 *     <li>Zip plus 4 "00000-0000"</li>
 * </ul>
 * </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>
 * HSSFDataFormatter.setDefaultNumberFormat(Format)</code>. <b>Note:</b> the
 * default format will only be used when a Format cannot be created from the
 * cell's data format string.
 *
 * @author James May (james dot may at fmr dot com)
 *
 */
public final class HSSFDataFormatter {

	/** 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("((A|P)[M/P]*)", Pattern.CASE_INSENSITIVE);

	/** A regex to find patterns like [$$-1009] and [$�-452]. */
	private static final Pattern specialPatternGroup = Pattern.compile("(\\[\\$[^-\\]]*-[0-9A-Z]+\\])");

	/** <em>General</em> format for whole numbers. */
	private static final Format generalWholeNumFormat = new DecimalFormat("#");

	/** <em>General</em> format for decimal numbers. */
	private static final Format generalDecimalNumFormat = new DecimalFormat("#.##########");

	/** 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 formats;

	/**
	 * Constructor
	 */
	public HSSFDataFormatter() {
		formats = new HashMap();

		// init built-in formats

		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);
	}

	/**
	 * Return a Format for the given cell if one exists, otherwise try to
	 * create one. This method will return <code>null</code> if the 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(HSSFCell cell) {
		if ( cell.getCellStyle() == null) {
			return null;
		}

		int formatIndex = cell.getCellStyle().getDataFormat();
		String formatStr = cell.getCellStyle().getDataFormatString();
		if(formatStr == null || formatStr.trim().length() == 0) {
			return null;
		}
		return getFormat(cell.getNumericCellValue(), formatIndex, formatStr);
	}

	private Format getFormat(double cellValue, int formatIndex, String formatStr) {
		Format format = (Format)formats.get(formatStr);
		if (format != null) {
			return format;
		}
		if (formatStr.equals("General")) {
			if (HSSFDataFormatter.isWholeNumber(cellValue)) {
				return generalWholeNumFormat;
			}
			return generalDecimalNumFormat;
		}
		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(HSSFCell 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) {
		// remove color formatting if present
		String formatStr = sFormat.replaceAll("\\[[a-zA-Z]*\\]", "");

		// try to extract special characters like currency
		Matcher m = specialPatternGroup.matcher(formatStr);
		while(m.find()) {
			String match = m.group();
			String symbol = match.substring(match.indexOf('$') + 1, match.indexOf('-'));
			if (symbol.indexOf('$') > -1) {
				StringBuffer sb = new StringBuffer();
				sb.append(symbol.substring(0, symbol.indexOf('$')));
				sb.append('\\');
				sb.append(symbol.substring(symbol.indexOf('$'), symbol.length()));
				symbol = sb.toString();
			}
			formatStr = m.replaceAll(symbol);
			m = specialPatternGroup.matcher(formatStr);
		}

		if(formatStr == null || formatStr.trim().length() == 0) {
			return getDefaultFormat(cellValue);
		}


		if(HSSFDateUtil.isADateFormat(formatIndex,formatStr) &&
				HSSFDateUtil.isValidExcelDate(cellValue)) {
			return createDateFormat(formatStr, cellValue);
		}
		if (numPattern.matcher(formatStr).find()) {
			return createNumberFormat(formatStr, cellValue);
		}
		// TODO - when does this occur?
		return null;
	}

	private Format createDateFormat(String pFormatStr, double cellValue) {
		String formatStr = pFormatStr;
		formatStr = formatStr.replaceAll("\\\\-","-");
		formatStr = formatStr.replaceAll("\\\\,",",");
		formatStr = formatStr.replaceAll("\\\\ "," ");
		formatStr = formatStr.replaceAll(";@", "");
		boolean hasAmPm = false;
		Matcher amPmMatcher = amPmPattern.matcher(formatStr);
		while (amPmMatcher.find()) {
			formatStr = amPmMatcher.replaceAll("@");
			hasAmPm = true;
			amPmMatcher = amPmPattern.matcher(formatStr);
		}
		formatStr = formatStr.replaceAll("@", "a");


		Matcher dateMatcher = daysAsText.matcher(formatStr);
		if (dateMatcher.find()) {
			String match = dateMatcher.group(0);
			formatStr = dateMatcher.replaceAll(match.toUpperCase().replaceAll("D", "E"));
		}

		// Convert excel date format to SimpleDateFormat.
		// Excel uses lower 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."
		*/

		StringBuffer sb = new StringBuffer();
		char[] chars = formatStr.toCharArray();
		boolean mIsMonth = true;
		List ms = new ArrayList();
		for(int j=0; j<chars.length; j++) {
			char c = chars[j];
			if (c == 'h' || c == 'H') {
				mIsMonth = false;
				if (hasAmPm) {
					sb.append('h');
				} else {
					sb.append('H');
				}
			}
			else if (c == 'm') {
				if(mIsMonth) {
					sb.append('M');
					ms.add(
							new Integer(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 i = 0; i < ms.size(); i++) {
					int index = ((Integer)ms.get(i)).intValue();
					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 {
				sb.append(c);
			}
		}
		formatStr = sb.toString();

		try {
			return new SimpleDateFormat(formatStr);
		} catch(IllegalArgumentException iae) {

			// the pattern could not be parsed correctly,
			// so fall back to the default number format
			return getDefaultFormat(cellValue);
		}

	}

	private Format createNumberFormat(String formatStr, double cellValue) {
		StringBuffer sb = new StringBuffer(formatStr);
		for (int i = 0; i < sb.length(); i++) {
			char c = sb.charAt(i);
			//handle (#,##0_);
			if (c == '(') {
				int idx = sb.indexOf(")", i);
				if (idx > -1 && sb.charAt(idx -1) == '_') {
					sb.deleteCharAt(idx);
					sb.deleteCharAt(idx - 1);
					sb.deleteCharAt(i);
					i--;
				}
			} else if (c == ')' && i > 0 && sb.charAt(i - 1) == '_') {
				sb.deleteCharAt(i);
				sb.deleteCharAt(i - 1);
				i--;
			// remove quotes and back slashes
			} else if (c == '\\' || c == '"') {
				sb.deleteCharAt(i);
				i--;

			// for scientific/engineering notation
			} else if (c == '+' && i > 0 && sb.charAt(i - 1) == 'E') {
				sb.deleteCharAt(i);