001/** 
002 * Copyright (c) 2007-2008, Regents of the University of Colorado 
003 * All rights reserved.
004 * 
005 * Redistribution and use in source and binary forms, with or without
006 * modification, are permitted provided that the following conditions are met:
007 * 
008 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
009 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 
010 * Neither the name of the University of Colorado at Boulder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 
011 * 
012 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
013 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
014 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
015 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
016 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
017 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
018 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
019 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
020 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
021 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
022 * POSSIBILITY OF SUCH DAMAGE. 
023 */
024package org.cleartk.ml.encoder.outcome;
025
026import java.io.File;
027import java.io.IOException;
028import java.io.PrintWriter;
029import java.util.ArrayList;
030import java.util.Collections;
031import java.util.List;
032import java.util.Map;
033import java.util.TreeMap;
034
035/**
036 * <br>
037 * Copyright (c) 2007-2008, Regents of the University of Colorado <br>
038 * All rights reserved.
039 */
040public class StringToIntegerOutcomeEncoder implements OutcomeEncoder<String, Integer> {
041
042  private static final long serialVersionUID = -4592095619017878663L;
043
044  public static final String LOOKUP_FILE_NAME = "outcome-lookup.txt";
045
046  public StringToIntegerOutcomeEncoder() {
047    nextIndex = 1;
048  }
049
050  public StringToIntegerOutcomeEncoder(int firstIndex) {
051    nextIndex = firstIndex;
052  }
053
054  public Integer encode(String input) {
055    if (input == null)
056      return null;
057
058    if (!map.containsKey(input)) {
059      map.put(input, nextIndex);
060      reverseMap.put(nextIndex, input);
061      nextIndex += 1;
062    }
063
064    return map.get(input);
065  }
066
067  public String decode(Integer outcome) {
068    if (outcome == null)
069      return null;
070
071    return reverseMap.get(outcome);
072  }
073
074  public void finalizeOutcomeSet(File outputDirectory) throws IOException {
075    File outputFile = new File(outputDirectory, LOOKUP_FILE_NAME);
076    PrintWriter writer = new PrintWriter(outputFile);
077    List<Integer> values = new ArrayList<Integer>(map.values());
078    Collections.sort(values);
079
080    for (int value : values) {
081      writer.format("%d %s\n", value, reverseMap.get(value));
082    }
083
084    writer.close();
085  }
086
087  private Map<String, Integer> map = new TreeMap<String, Integer>();
088
089  private Map<Integer, String> reverseMap = new TreeMap<Integer, String>();
090
091  private int nextIndex;
092
093}