extras/rya.geoindexing/geo.common/src/main/java/org/apache/rya/indexing/GeoTemporalIndexerType.java

/*
 * 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.
 */
package org.apache.rya.indexing;

import static com.google.common.base.Preconditions.checkNotNull;


/**
 * A list of all the types of Geo indexers supported in Rya.
 */
public enum GeoTemporalIndexerType {
	/**
	 * MongoDB based GeoTemporal index and optimizer go together.
	 */
	MONGO_GEO_TEMPORAL("org.apache.rya.indexing.geotemporal.mongo.MongoGeoTemporalIndexer"),
	MONGO_GEO_TEMPORAL_OPTIMIZER("org.apache.rya.indexing.geotemporal.GeoTemporalOptimizer"), 
	/**
	 * No mention of a type is specified, so use default.
	 */
	UNSPECIFIED("no_index_was_configured");
	private String geoTemporalIndexerClassString;

    /**
     * Creates a new {@link GeoTemporalIndexerType}.
     * @param geoIndexerClass the {@link GeoIndexer} {@link Class}.
     * (not {@code null})
     */
    private GeoTemporalIndexerType(final String geoIndexerClassString) {
        this.geoTemporalIndexerClassString = checkNotNull(geoIndexerClassString);
    }

    /**
     * @return the {@link GeoIndexer} {@link Class}. (not {@code null})
     */
    public String getGeoTemporalIndexerClassString() {
        return geoTemporalIndexerClassString;
	}

}