001/** 
002 * Copyright (c) 2011, 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.jar;
025
026import java.io.BufferedInputStream;
027import java.io.FileInputStream;
028import java.io.IOException;
029import java.io.InputStream;
030import java.net.MalformedURLException;
031import java.net.URL;
032import java.util.jar.JarInputStream;
033
034import org.apache.uima.UimaContext;
035import org.apache.uima.resource.ResourceInitializationException;
036import org.apache.uima.fit.component.initialize.ConfigurationParameterInitializer;
037import org.apache.uima.fit.descriptor.ConfigurationParameter;
038import org.apache.uima.fit.factory.initializable.Initializable;
039
040/**
041 * <br>
042 * Copyright (c) 2011, Regents of the University of Colorado <br>
043 * All rights reserved.
044 */
045public abstract class GenericJarClassifierFactory<CLASSIFIER_TYPE> implements Initializable {
046
047  public static final String PARAM_CLASSIFIER_JAR_PATH = "classifierJarPath";
048
049  @ConfigurationParameter(
050      name = PARAM_CLASSIFIER_JAR_PATH,
051      mandatory = true,
052      description = "provides the path to the jar file that should be used to instantiate the classifier.")
053  private String classifierJarPath;
054
055  public void setClassifierJarPath(String classifierJarPath) {
056    this.classifierJarPath = classifierJarPath;
057  }
058
059  public void initialize(UimaContext context) throws ResourceInitializationException {
060    ConfigurationParameterInitializer.initialize(this, context);
061  }
062
063  public CLASSIFIER_TYPE createClassifier() throws IOException {
064    InputStream stream = this.getClass().getResourceAsStream(this.classifierJarPath);
065    if (stream == null) {
066      try {
067        stream = new URL(this.classifierJarPath).openStream();
068      } catch (MalformedURLException e) {
069        stream = new FileInputStream(this.classifierJarPath);
070      }
071    }
072    stream = new BufferedInputStream(stream);
073    JarInputStream modelStream = new JarInputStream(stream);
074    JarClassifierBuilder<?> builder = JarClassifierBuilder.fromManifest(modelStream.getManifest());
075    try {
076      return this.getClassifierClass().cast(builder.loadClassifier(modelStream));
077    } finally {
078      stream.close();
079    }
080  }
081
082  protected abstract Class<CLASSIFIER_TYPE> getClassifierClass();
083}