IMSlexConverter.java

/*******************************************************************************
 * Copyright 2016
 * Ubiquitous Knowledge Processing (UKP) Lab
 * Technische Universität Darmstadt
 *
 * Licensed 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 de.tudarmstadt.ukp.lmf.transform.imslex;

import java.io.IOException;
import java.util.LinkedList;

import de.tudarmstadt.ukp.lmf.model.core.GlobalInformation;
import de.tudarmstadt.ukp.lmf.model.core.LexicalResource;
import de.tudarmstadt.ukp.lmf.model.core.Lexicon;

/**
 * This class converts a preprocessed version of IMSlex - Subcategorization Frames (SCF)
 *  (see PhD thesis of Judith Eckle-Kohler, 1999) to Uby-LMF.
 * This lexical resource provides SCFs of verbs, nouns and adjectives as well as some additional
 * syntactic and semantic properties of nouns and adjectives.
 * @author Judith Eckle-Kohler
 * @deprecated Use {@link org.dkpro.uby.imslex.IMSLexSubcatConverter} instead.
 */
@Deprecated
public class IMSlexConverter {

	protected LexicalResource lexicalResource;
	private final String dtd_version;

	public IMSlexConverter(LexicalResource lexicalResource, String dtd)
	{
		super();
		this.lexicalResource = lexicalResource;
		this.dtd_version = dtd;
	}

	/**
	 * Converts a preprocessed version of IMSLex to Uby-LMF
	 * name of the LMF Lexicon instance: "IMSLexSubcat"
	 * @throws IOException
	 */
	public void toLMF(IMSlexExtractor germanVcExtractor) throws IOException {

		// *** Setting GlobalInformation *** //
		GlobalInformation globalInformation = new GlobalInformation();
		globalInformation.setLabel("IMSLex, see PhD thesis of Eckle-Kohler (1999), Version of 09/2011");

		// Setting attributes of LexicalResource
		lexicalResource.setGlobalInformation(globalInformation);
		lexicalResource.setName("IMSLexSubcat");
		lexicalResource.setDtdVersion(dtd_version);

		LinkedList<Lexicon> lexicons = new LinkedList<Lexicon>();
		lexicons.add(germanVcExtractor.lexicon); // Setting lexicon (extracted from the IMSlex subset)
		lexicalResource.setLexicons(lexicons);
	}

	/**
	 * Returns the {@link LexicalResource} object, which contains the results of the conversion
	 * @return an instance of LexicalResource, which contains the results of the conversion
	 */
	public LexicalResource getLexicalResource() {
		return lexicalResource;
	}

}