/**
 * <copyright> Copyright 2006 by Know-Center, Graz, Austria </copyright>
 * PDF-AS has been contracted by the E-Government Innovation Center EGIZ, a
 * joint initiative of the Federal Chancellery Austria and Graz University of
 * Technology.
 *
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 * http://www.osor.eu/eupl/
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and
 * limitations under the Licence.
 *
 * This product combines work with different licenses. See the "NOTICE" text
 * file for details on the various modules and licenses.
 * The "NOTICE" text file is part of the distribution. Any derivative works
 * that you distribute must include a readable copy of the "NOTICE" text file.
 *
 * $Id: StringInfo.java,v 1.2 2006/10/11 07:57:58 wprinz Exp $
 */
package at.knowcenter.wag.egov.egiz.pdf;

import java.io.Serializable;
import java.io.UnsupportedEncodingException;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Specifies a certain data area within the pdf.
 * 
 * <p>
 * Actually this is a byte range, which is used to hold the placeholder ranges
 * for later replacement.
 * </p>
 * 
 * @author wprinz
 */
public class StringInfo implements Serializable
{
  /**
   * SVUID.
   */
  private static final long serialVersionUID = 5834801907046737048L;

  protected static Log logger = LogFactory.getLog(StringInfo.class);

  /**
   * The PDF document this range belongs to.
   */
  public byte[] pdf = null;

  /**
   * The start offset of the range.
   */
  public int string_start = -1;

  /**
   * The length of the range.
   */
  public int string_length = -1;

  /**
   * Copies the bytes of this range to a new byte array.
   * 
   * @return Returns the new byte array.
   */
  public byte[] copyStringBytes()
  {
    byte[] bytes = new byte[this.string_length];
    System.arraycopy(this.pdf, this.string_start, bytes, 0, this.string_length);
    return bytes;
  }

  /**
   * Converts the range into a String.
   * 
   * @return Returns the String.
   * @throws UnsupportedEncodingException
   *           Forwarded exception.
   */
  public String getString(String encoding) throws UnsupportedEncodingException
  {
    byte[] bytes = copyStringBytes();
    return new String(bytes, encoding);
  }

  public String toString()
  {
    try
    {
      return "(" + this.string_start + "," + this.string_length + ")" + getString("ISO-8859-1");
    }
    catch (UnsupportedEncodingException e)
    {
       logger.error(e.getMessage(), e);
      return "(" + this.string_start + "," + this.string_length + ")";
    }
  }

}