/*******************************************************************************
 * Copyright 2015-2016 - CNRS (Centre National de Recherche Scientifique)
 *
 * 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.
 *
 *******************************************************************************/

/*
 * 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 2, 2015nership.  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 eu.project.ttc.resources;

import java.util.Set;

import org.apache.uima.resource.SharedResourceObject;

public interface GeneralLanguage extends SharedResourceObject {
	public static final String PARAM_NB_CORPUS_WORDS = "__NB_CORPUS_WORDS__";
	public static final int NORMALIZATION_WORD_FREQUENCY = 1000000;
	public static final double NORMALIZED_HAPAX_FREQUENCY = 1d/NORMALIZATION_WORD_FREQUENCY;

	@Deprecated
	public double getNormalizedFrequency(String entry);

	public boolean findSingleWord(String word);

	public Set<String> getWords();

	public int getNbCorpusWords();

	public int getFrequency(String lemma, String pattern);

	/**
	 * Only for old version of GeneralLanguage resources, that do not 
	 * have a __NB_CORPUS_WORDS__ key.
	 * 
	 * @return
	 */
	@Deprecated
	public boolean isCumulatedFrequencyMode();
}