Feature.java

Go to the documentation of this file.

/*******************************************************************************
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use these files 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 uk.ac.cam.eng.rule.features;

public enum Feature {

        /*
         * The order of the enum dictates the index of the feature in the HFile. To maintain backwards 
         * compatibility with old HFiles only add features to the end of this enum. Do not insert 
         * new features in between existing features. 
         */
        
        SOURCE2TARGET_PROBABILITY(Scope.GLOBAL, ComputeLocation.MAP_REDUCE),
        TARGET2SOURCE_PROBABILITY(Scope.GLOBAL, ComputeLocation.MAP_REDUCE),
        PROVENANCE_SOURCE2TARGET_PROBABILITY(Scope.PROVENANCE, ComputeLocation.MAP_REDUCE),
        PROVENANCE_TARGET2SOURCE_PROBABILITY(Scope.PROVENANCE, ComputeLocation.MAP_REDUCE),
        GLUE_RULE(Scope.GLOBAL, ComputeLocation.RETRIEVAL),
        INSERT_SCALE(Scope.GLOBAL, ComputeLocation.RETRIEVAL),
        SOURCE2TARGET_LEXICAL_PROBABILITY(Scope.GLOBAL, ComputeLocation.LEXICAL_SERVER),
        TARGET2SOURCE_LEXICAL_PROBABILITY(Scope.GLOBAL, ComputeLocation.LEXICAL_SERVER),
        PROVENANCE_SOURCE2TARGET_LEXICAL_PROBABILITY(Scope.PROVENANCE, ComputeLocation.LEXICAL_SERVER),
        PROVENANCE_TARGET2SOURCE_LEXICAL_PROBABILITY(Scope.PROVENANCE, ComputeLocation.LEXICAL_SERVER),
        RULE_COUNT_1(Scope.GLOBAL, ComputeLocation.RETRIEVAL),
        RULE_COUNT_2(Scope.GLOBAL, ComputeLocation.RETRIEVAL),
        RULE_COUNT_GREATER_THAN_2(Scope.GLOBAL, ComputeLocation.RETRIEVAL),
        RULE_INSERTION_PENALTY(Scope.GLOBAL, ComputeLocation.RETRIEVAL),
        WORD_INSERTION_PENALTY(Scope.GLOBAL, ComputeLocation.RETRIEVAL);
        
        public static enum Scope{
                GLOBAL, PROVENANCE;
        }
        
        public static enum ComputeLocation{
                MAP_REDUCE, RETRIEVAL, LEXICAL_SERVER;
        }
        
        public Scope scope;
        public ComputeLocation computed;
        
        private Feature(Scope scope, ComputeLocation comp){
                this.scope = scope;
                this.computed = comp;
        }
        
        public String getConfName() {
                return name().toLowerCase();
        }

        public static Feature findFromConf(String name) {
                return valueOf(name.toUpperCase());
        }
        
}