/**
 * <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: FoundKey.java,v 1.1 2006/08/25 17:07:21 wprinz Exp $
 */
package at.knowcenter.wag.egov.egiz.framework;

/**
 * Holds the information of one found key.
 * @author wprinz
 */
public class FoundKey
{
  /**
   * The type of the key.
   */
  public String key = null;

  /**
   * The caption of the key.
   */
  public String caption = null;

  /**
   * The start index of the caption in the text.
   */
  public int start_index = -1;

  /**
   * 
   * @param key The type of the key.
   * @param caption The caption of the key.
   * @param start_index The start index of the caption in the text.
   */
  public FoundKey(String key, String caption, int start_index)
  {
    this.key = key;
    this.caption = caption;
    this.start_index = start_index;
  }

  /**
   * Returns the key.
   * @return Returns the key.
   */
  public String getKey()
  {
    return this.key;
  }

  /**
   * Returns the start_index.
   * @return Returns the start_index.
   */
  public int getStartIndex()
  {
    return this.start_index;
  }

  /**
   * @see java.lang.Object#toString()
   */
  public String toString()
  {
    return this.key + "(" + this.caption + ")@" + this.start_index;
  }

  /**
   * Tells, if this FoundKey is semantically equal to the other FoundKey.
   * 
   * <p>
   * Two FoundKeys are semantically equal if their key and caption are the same.
   * </p>
   * 
   * @param other_found_key
   *          The other FoundKey.
   * @return Returns true if the two keys are semantically equal.
   */
  public boolean isSemanticallyEqual(FoundKey other_found_key)
  {
    return this.key.equals(other_found_key.key) && this.caption.equals(other_found_key.caption);
  }

}