net.sf.okapi.common.encoder.XMLEncoder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of okapi-lib Show documentation
There is a newer version: 1.47.0
/*===========================================================================
  Copyright (C) 2008-2010 by the Okapi Framework contributors
-----------------------------------------------------------------------------
  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 net.sf.okapi.common.encoder;

import java.nio.charset.Charset;
import java.nio.charset.CharsetEncoder;

import net.sf.okapi.common.IParameters;
import net.sf.okapi.common.StringParameters;

/**
 * Implements {@link IEncoder} for XML format.
 */
public class XMLEncoder implements IEncoder {

	/**
	 * Parameter flag for escaping the greater-than characters.
	 */
	public static final String ESCAPEGT = "escapeGT";
	/**
	 * Parameter flag for escaping the non-breaking space characters.
	 */
	public static final String ESCAPENBSP = "escapeNbsp";
	/**
	 * Parameter flag for escaping the line-breaks.
	 */
	public static final String ESCAPELINEBREAK = "escapeLineBreak";
	
	/**
	 * Parameter flag for indicating that the {@link #QUOTEMODE} is defined. 
	 */
	public static final String QUOTEMODEDEFINED = "quoteModeDefined";
	
	/**
	 * Parameter flag for defining the quote mode.
	 */
	public static final String QUOTEMODE = "quoteMode";
	
	private CharsetEncoder chsEnc;
	private String lineBreak;
	private String encoding;
	private boolean escapeGT = false;
	private boolean escapeNbsp = false;
	private boolean escapeLineBreak = false;
	private QuoteMode quoteMode = QuoteMode.ALL;
	private IParameters params;
	private char last = Character.MAX_VALUE;

	public XMLEncoder(String encoding, String lineBreak,
			boolean escapeGT, boolean escapeNbsp, boolean escapeLineBreak,
			QuoteMode quoteMode) {
		super();
		this.escapeGT = escapeGT;
		this.escapeNbsp = escapeNbsp;
		this.escapeLineBreak = escapeLineBreak;
		this.quoteMode = quoteMode;
		setOptions(null, encoding, lineBreak);
	}

	public XMLEncoder() {
		super();
	}

	@Override
	public void reset() {
		this.last = Character.MAX_VALUE;
	}

	/**
	 * Sets the options for this encoder. This encoder supports the following
	 * parameters:
	 * escapeGT=true to converts '>' characters to to &gt;.
	 * escapeNbsp=true to converts non-breaking space to &#x00a0;.
	 * escapeLineBreak=true to converts line-breaks to &#10;.
	 * 
	 * @param params the parameters object with all the configuration information 
	 * specific to this encoder.
	 * @param encoding the name of the character set encoding to use.
	 * @param lineBreak the type of line break to use.
	 */
	@Override
	public void setOptions (IParameters params,
		String encoding,
		String lineBreak)
	{
		this.lineBreak = lineBreak;
		this.encoding = encoding; 
		// Use an encoder only if the output is not UTF-8/16
		// since those support all characters
		String enclc = encoding.toLowerCase();
		if ( enclc.equals("utf-8") || enclc.startsWith("utf-16") ) {
			chsEnc = null;
		}
		else {
			chsEnc = Charset.forName(encoding).newEncoder();
		}
		
		this.params = params;		
		if ( params != null ) {
			// Retrieve the options
			escapeGT = params.getBoolean(ESCAPEGT);
			escapeNbsp = params.getBoolean(ESCAPENBSP);
			escapeLineBreak = params.getBoolean(ESCAPELINEBREAK);
			if ( params.getBoolean(QUOTEMODEDEFINED) ) {
				quoteMode = QuoteMode.fromValue(params.getInteger(QUOTEMODE));
			}
		}
	}

	@Override
	public String encode (String text, 
			EncoderContext context)
	{
		if ( text == null ) return "";
		
		StringBuilder sbTmp = new StringBuilder(text.length());
		for ( int i=0; i':
			if ( escapeGT || last == ']' ) return ">";
			else return ">";
		case '\r': // In XML this is a literal not a line-break
			return "";
		case '\n':
			if ( escapeLineBreak ) return "
";
			else return lineBreak;
		case '\u00A0':
			if ( escapeNbsp ) {
				return " ";
			}
			// Else: fall through
		default:
			if ( value > 127 ) { // Extended chars
				// Store high surrogate for future use
				if ( Character.isHighSurrogate(value) ) {
					return "";
				}
				// Combine stored surrogate with current char to make a single codepoint
				if ( Character.isHighSurrogate(last) ) {
					int cp = Character.toCodePoint(last, value);
					String tmp = new String(Character.toChars(cp));
					if (( chsEnc != null ) && !chsEnc.canEncode(tmp) ) {
						return String.format("&#x%x;", cp);
					}
					else {
						return tmp;
					}
				}
				if (( chsEnc != null ) && ( !chsEnc.canEncode(value) )) {
					return String.format("&#x%04x;", (int)value);
				}
				else { // No encoder or char is supported
					return String.valueOf(value);
				}
			}
			else { // ASCII chars
				return String.valueOf(value);
			}
		}
	}

	@Override
	public String encode (int value,
			EncoderContext context)
	{
		if (Character.isSupplementaryCodePoint(value) ) {
			String tmp = new String(Character.toChars(value));
			if (( chsEnc != null ) && !chsEnc.canEncode(tmp) ) {
				return String.format("&#x%x;", value);
			}
			return tmp;
		}
		return encode((char)value, context);
	}

	@Override
	public String toNative (String propertyName,
		String value)
	{
		// PROP_ENCODING: Same value in native
		// PROP_LANGUGE: Same value in native
		return value;
	}

	@Override
	public String getLineBreak () {
		return lineBreak;
	}

	@Override
	public CharsetEncoder getCharsetEncoder () {
		return chsEnc;
	}

	@Override
	public IParameters getParameters() {
		return params;
	}

	@Override
	public String getEncoding() {
		return encoding;
	}

    /**
     * Provides encoder parameters.
     */
	public static final class Parameters extends StringParameters {

		public Parameters(final boolean escapeGt, final boolean escapeNbsp,
						  final boolean escapeLineBreak, final QuoteMode quoteMode) {
			setBoolean(ESCAPEGT, escapeGt);
			setBoolean(ESCAPENBSP, escapeNbsp);
			setBoolean(ESCAPELINEBREAK, escapeLineBreak);
			setBoolean(QUOTEMODEDEFINED, true);
			setInteger(QUOTEMODE, quoteMode.toValue());
		}

		/**
		 * Prevents to reset the parameters.
		 */
		@Override
		public void reset() {
		}
	}
}