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.features;
025
026import java.util.ArrayList;
027import java.util.Collections;
028import java.util.List;
029
030import org.cleartk.ml.Feature;
031import org.cleartk.ml.encoder.CleartkEncoderException;
032import org.cleartk.ml.encoder.features.normalizer.NameNumberNormalizer;
033import org.cleartk.ml.encoder.features.normalizer.NoOpNormalizer;
034import org.cleartk.ml.feature.FeatureCollection;
035
036/**
037 * <br>
038 * Copyright (c) 2007-2008, Regents of the University of Colorado <br>
039 * All rights reserved.
040 * 
041 * @author Philipp Wetzler
042 */
043
044public class FeatureCollectionEncoder implements FeatureEncoder<NameNumber> {
045
046  private static final long serialVersionUID = -7840242678514710238L;
047
048  public FeatureCollectionEncoder(
049      String identifier,
050      FeatureEncoder<NameNumber> subEncoder,
051      NameNumberNormalizer normalizer) {
052    this.identifier = identifier;
053    this.normalizer = normalizer;
054    this.subEncoder = subEncoder;
055  }
056
057  public FeatureCollectionEncoder(
058      FeatureEncoder<NameNumber> subEncoder,
059      NameNumberNormalizer normalizer) {
060    this(null, subEncoder, normalizer);
061  }
062
063  public FeatureCollectionEncoder(String name, FeatureEncoder<NameNumber> subEncoder) {
064    this(name, subEncoder, new NoOpNormalizer());
065  }
066
067  public FeatureCollectionEncoder(FeatureEncoder<NameNumber> subEncoder) {
068    this(null, subEncoder, new NoOpNormalizer());
069  }
070
071  public List<NameNumber> encode(Feature feature) throws CleartkEncoderException {
072    FeatureCollection fc = (FeatureCollection) feature.getValue();
073    List<NameNumber> fves = new ArrayList<NameNumber>();
074
075    if (identifier != null && !identifier.equals(fc.getIdentifier()))
076      return Collections.emptyList();
077
078    for (Feature f : fc.getFeatures()) {
079      Feature f1 = new Feature(Feature.createName(feature.getName(), f.getName()), f.getValue());
080      fves.addAll(subEncoder.encode(f1));
081    }
082
083    normalizer.normalize(fves);
084
085    return fves;
086  }
087
088  public boolean encodes(Feature feature) {
089    if (feature.getValue() instanceof FeatureCollection) {
090      FeatureCollection f = (FeatureCollection) feature.getValue();
091
092      if (identifier == null || identifier.equals(f.getIdentifier()))
093        return true;
094      else
095        return false;
096    }
097
098    return false;
099  }
100
101  private String identifier;
102
103  private NameNumberNormalizer normalizer = new NoOpNormalizer();
104
105  private FeatureEncoder<NameNumber> subEncoder = null;
106}