de.twitterlivesearch.api.TwitterLiveSearchFactory.java Source code

Introduction

Here is the source code for de.twitterlivesearch.api.TwitterLiveSearchFactory.java

Source

/*
 * Copyright 2015 Tobias Larscheid, Jan Schmitz-Hermes, Felix Nordhusen, Florian Scheil
 *
 * 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.twitterlivesearch.api;

import java.io.IOException;
import java.nio.file.Paths;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.lucene.index.IndexWriter;
import org.apache.lucene.index.IndexWriterConfig;
import org.apache.lucene.store.Directory;
import org.apache.lucene.store.FSDirectory;
import org.apache.lucene.store.RAMDirectory;

import twitter4j.TwitterStream;
import twitter4j.TwitterStreamFactory;
import de.twitterlivesearch.analysis.AnalyzerMapping;
import de.twitterlivesearch.analysis.Searcher;
import de.twitterlivesearch.api.configuration.ConfigurationHolder;
import de.twitterlivesearch.api.configuration.build.AbstractConfiguration;
import de.twitterlivesearch.api.configuration.build.ConfigurationBuilder;
import de.twitterlivesearch.api.configuration.build.ConfigurationFactory;
import de.twitterlivesearch.api.configuration.build.DefaultConfiguration;
import de.twitterlivesearch.api.configuration.management.ConfigurationValues.DirectoryConfig;
import de.twitterlivesearch.api.configuration.management.ConfigurationValues.StreamConfig;
import de.twitterlivesearch.model.TweetHolder;
import de.twitterlivesearch.twitter.TwitterStreamListener;

/**
 * The Factory class, which is need to build {@link TwitterLiveSearch}. <br />
 * This factory configures all the necessary dependencies regarding Twitter4J, Lucene and so on. <br />
 * Please always use this factory in order to create a {@link TwitterLiveSearch}.
 * @author schmitzhermes
 *
 */
public class TwitterLiveSearchFactory {
    private static Logger log = LogManager.getLogger();

    /**
     * builds {@link TwitterLiveSearch} on top of the {@link DefaultConfiguration}
     * @return a configured and running instance of {@link TwitterLiveSearch}
     */
    public static TwitterLiveSearch build() {
        ConfigurationFactory.createConfiguration();
        return configureTwitter(ConfigurationHolder.getConfiguration());
    }

    /**
     * builds {@link TwitterLiveSearch} on top of an own configuration
     * @param userConfig
     * @return a configured and running instance of {@link TwitterLiveSearch}
     */
    public static TwitterLiveSearch build(AbstractConfiguration userConfig) {
        ConfigurationFactory.createConfiguration(userConfig);
        return configureTwitter(ConfigurationHolder.getConfiguration());
    }

    /**
     * builds {@link TwitterLiveSearch} with the help of a {@link ConfigurationBuilder}
     * @param configBuilder the configuration builder
     * @return  a configured and running instance of {@link TwitterLiveSearch}
     */
    public static TwitterLiveSearch build(ConfigurationBuilder configBuilder) {
        ConfigurationFactory.createConfiguration(configBuilder.build());
        return configureTwitter(ConfigurationHolder.getConfiguration());
    }

    private static TwitterLiveSearch configureTwitter(AbstractConfiguration configuration) {
        TwitterLiveSearch twitter = null;
        try {
            // several important variables are initialized here
            twitter = new TwitterLiveSearch();
            TweetHolder tweetHolder = new TweetHolder();
            IndexWriterConfig indexWriterConfig = new IndexWriterConfig(
                    AnalyzerMapping.getInstance().ANALYZER_FOR_DELIMITER);
            TwitterStream twitterStream = new TwitterStreamFactory().getInstance();
            Directory directory;

            // confguration part: TwitterLiveSearch is configured here
            // according to the config
            if (configuration.getDirectoryConfig() == DirectoryConfig.RAM) {
                directory = new RAMDirectory();
                log.trace("initialized RAM-Directory");
            } else {
                directory = FSDirectory.open(Paths.get(configuration.getDirectory()));
                log.trace("initialized FS-Directory on path " + configuration.getDirectory());
            }
            IndexWriter iwriter = new IndexWriter(directory, indexWriterConfig);
            Searcher searcher = new Searcher(directory);

            twitterStream.addListener(new TwitterStreamListener(directory, tweetHolder, iwriter, searcher));
            if (configuration.getStreamConfig() == StreamConfig.USER_STREAM) {
                twitterStream.user();
            } else if (configuration.getStreamConfig() == StreamConfig.GARDENHOSE) {
                twitterStream.sample();
            }

            // set everything needed in TwitterLiveSearch
            twitter.setCurrentDirectory(directory);
            twitter.setIndexWriter(iwriter);
            twitter.setTweetHolder(tweetHolder);
            twitter.setTwitterStream(twitterStream); // Referenz auf
            // TwitterLiveSearch
            twitter.setSearcher(searcher);

        } catch (IOException e) {
            e.printStackTrace();

        }

        return twitter;
    }
}