Formatter.java

/*
 * © Copyright FOCONIS AG, 2014
 * 
 * Licensed 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.openntf.formula;

import java.util.Date;
import java.util.Locale;

import com.ibm.icu.util.Calendar;

// TODO RPr Needs a lot of comments
public interface Formatter {

	Locale getLocale();

	/*----------------------------------------------------------------------------*/
	DateTime getNewSDTInstance();

	DateTime getNewInitializedSDTInstance(Date date, boolean noDate, boolean noTime);

	DateTime getCopyOfSDTInstance(DateTime sdt);

	/*----------------------------------------------------------------------------*/
	DateTime parseDate(String image);

	DateTime parseDate(String image, boolean parseLenient);

	Calendar parseDateToCal(String image, boolean[] noDT, boolean parseLenient);

	DateTime parseDateWithFormat(String image, String format, boolean parseLenient);

	Calendar parseDateToCalWithFormat(String image, String format, boolean[] noDT, boolean parseLenient);

	/*----------------------------------------------------------------------------*/
	Number parseNumber(String image);

	Number parseNumber(String image, boolean lenient);

	/*----------------------------------------------------------------------------*/
	public class LotusDateTimeOptions {
		public final static int D_YMD = 0;		// D0
		public final static int D_YMD_YOPT = 1;	// D1
		public final static int D_MD = 2;		// D1
		public final static int D_YM = 3;		// D3
		public final static int T_HMS = 0;		// T0
		public final static int T_HM = 1;		// T1
		public final static int Z_CONV = 0;		// Z0
		public final static int Z_DISP_OPT = 1;	// Z1
		public final static int Z_DISP_ALW = 2;	// Z2
		public final static int S_D_ONLY = 0;	// S0
		public final static int S_T_ONLY = 1;	// S1
		public final static int S_DT = 2;		// S2
		public final static int S_DT_TY = 3;	// S3

		public int dOption = -1;
		public int tOption = -1;
		public int zOption = -1;
		public int sOption = -1;

		public boolean nothingSet() {
			return (dOption + tOption + zOption + sOption == -4);
		}

		public String dOptToStr() {
			return "D" + dOption;
		}

		public String tOptToStr() {
			return "T" + tOption;
		}

		public String zOptToStr() {
			return "Z" + zOption;
		}

		public String sOptToStr() {
			return "S" + sOption;
		}
	}

	public static final int TIMEFORMAT_MEDIUM = 1;
	public static final int TIMEFORMAT_SHORT = 2;
	public static final int TIMEFORMAT_LONG = 3;

	String formatDateTime(DateTime sdt);

	String formatDateTime(DateTime sdt, LotusDateTimeOptions ldto);

	String formatCalDateTime(Calendar cal);

	String formatCalDateTime(Calendar cal, int timeFormat);

	String formatCalDateOnly(Calendar cal);

	String formatCalTimeOnly(Calendar cal);

	String formatCalTimeOnly(Calendar cal, int timeFormat);

	String formatDateTimeWithFormat(DateTime sdt, String format);

	String formatCalWithFormat(Calendar cal, String format);

	/*----------------------------------------------------------------------------*/
	public class LotusNumberOptions {
		public boolean useGrouping = false;
		public char format = 0;
		public int fractionDigits = -1;
		public boolean negativeAsParentheses = false;

		public void setDefault() {
			format = 'G';
		}
	}

	String formatNumber(Number n);

	String formatNumber(Number n, LotusNumberOptions lno);
}