SegGraph.java

/**
 * 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.lucene.analysis.cn.smart.hhmm;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

/**
 * Graph representing possible tokens at each start offset in the sentence.
 * <p>
 * For each start offset, a list of possible tokens is stored.
 * </p>
 * <p><font color="#FF0000">
 * WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental. 
 * The APIs and file formats introduced here might change in the future and will not be 
 * supported anymore in such a case.</font>
 * </p>
 */
class SegGraph {

  /**
   * Map of start offsets to ArrayList of tokens at that position
   */
  private Map /* <Integer, ArrayList<SegToken>> */ tokenListTable = new HashMap();

  private int maxStart = -1;

  /**
   * Returns true if a mapping for the specified start offset exists
   * 
   * @param s startOffset
   * @return true if there are tokens for the startOffset
   */
  public boolean isStartExist(int s) {
    return tokenListTable.get(new Integer(s)) != null;
  }

  /**
   * Get the list of tokens at the specified start offset
   * 
   * @param s startOffset
   * @return List of tokens at the specified start offset.
   */
  public List getStartList(int s) {
    return (List) tokenListTable.get(new Integer(s));
  }

  /**
   * Get the highest start offset in the map
   * 
   * @return maximum start offset, or -1 if the map is empty.
   */
  public int getMaxStart() {
    return maxStart;
  }

  /**
   * Set the {@link SegToken#index} for each token, based upon its order by startOffset. 
   * @return a {@link List} of these ordered tokens.
   */
  public List makeIndex() {
    List result = new ArrayList();
    int s = -1, count = 0, size = tokenListTable.size();
    List tokenList;
    short index = 0;
    while (count < size) {
      if (isStartExist(s)) {
        tokenList = (List) tokenListTable.get(new Integer(s));
        for (Iterator iter = tokenList.iterator(); iter.hasNext();) {
          SegToken st = (SegToken) iter.next();
          st.index = index;
          result.add(st);
          index++;
        }
        count++;
      }
      s++;
    }
    return result;
  }

  /**
   * Add a {@link SegToken} to the mapping, creating a new mapping at the token's startOffset if one does not exist. 
   * @param token {@link SegToken}
   */
  public void addToken(SegToken token) {
    int s = token.startOffset;
    if (!isStartExist(s)) {
      ArrayList newlist = new ArrayList();
      newlist.add(token);
      tokenListTable.put((Object) (new Integer(s)), newlist);
    } else {
      List tokenList = (List) tokenListTable.get((Object) (new Integer(s)));
      tokenList.add(token);
    }
    if (s > maxStart)
      maxStart = s;
  }

  /**
   * Return a {@link List} of all tokens in the map, ordered by startOffset.
   * 
   * @return {@link List} of all tokens in the map.
   */
  public List toTokenList() {
    List result = new ArrayList();
    int s = -1, count = 0, size = tokenListTable.size();
    List tokenList;

    while (count < size) {
      if (isStartExist(s)) {
        tokenList = (List) tokenListTable.get(new Integer(s));
        for (Iterator iter = tokenList.iterator(); iter.hasNext();) {
          SegToken st = (SegToken) iter.next();
          result.add(st);
        }
        count++;
      }
      s++;
    }
    return result;
  }

  public String toString() {
    List tokenList = this.toTokenList();
    StringBuffer sb = new StringBuffer();
    for (Iterator iter = tokenList.iterator(); iter.hasNext();) {
      SegToken t = (SegToken) iter.next();
      sb.append(t + "\n");
    }
    return sb.toString();
  }
}