com.joliciel.talismane.machineLearning.features.OrFeatureAllowNulls Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of talismane-machine-learning Show documentation

There is a newer version: 6.1.8

Show newest version

///////////////////////////////////////////////////////////////////////////////
//Copyright (C) 2014 Joliciel Informatique
//
//This file is part of Talismane.
//
//Talismane is free software: you can redistribute it and/or modify
//it under the terms of the GNU Affero General Public License as published by
//the Free Software Foundation, either version 3 of the License, or
//(at your option) any later version.
//
//Talismane is distributed in the hope that it will be useful,
//but WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//GNU Affero General Public License for more details.
//
//You should have received a copy of the GNU Affero General Public License
//along with Talismane.  If not, see .
//////////////////////////////////////////////////////////////////////////////
package com.joliciel.talismane.machineLearning.features;

import com.joliciel.talismane.TalismaneException;

/**
 * Combines two or more boolean features using a boolean OR. If any feature
 * returns null, it will be considered as false.
 * 
 * @author Assaf Urieli
 *
 */
public class OrFeatureAllowNulls extends AbstractCachableFeatureimplements BooleanFeature {
  BooleanFeature[] booleanFeatures;

  @SafeVarargs
  public OrFeatureAllowNulls(BooleanFeature... booleanFeatures) {
    super();
    this.booleanFeatures = booleanFeatures;
    String name = "";
    boolean firstFeature = true;
    for (BooleanFeature booleanFeature : booleanFeatures) {
      if (!firstFeature)
        name += "|";
      name += booleanFeature.getName();
      firstFeature = false;
    }
    this.setName(name);
  }

  @Override
  public FeatureResult checkInternal(T context, RuntimeEnvironment env) throws TalismaneException {
    FeatureResult featureResult = null;

    boolean booleanResult = false;
    for (BooleanFeature booleanFeature : booleanFeatures) {
      FeatureResult result = booleanFeature.check(context, env);
      boolean value = false;
      if (result != null) {
        value = result.getOutcome();
      }
      booleanResult = booleanResult || value;
      if (booleanResult)
        break;
    }

    featureResult = this.generateResult(booleanResult);
    return featureResult;
  }

  public BooleanFeature[] getBooleanFeatures() {
    return booleanFeatures;
  }
}