com.dooapp.gaedo.blueprints.indexable.IndexNames Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gaedo-blueprints Show documentation

Implementation of gaedo mechanisms backed by blueprints graph layer

There is a newer version: 1.0.16

package com.dooapp.gaedo.blueprints.indexable;

import java.util.Collection;
import java.util.LinkedList;

import com.tinkerpop.blueprints.Edge;
import com.tinkerpop.blueprints.Element;
import com.tinkerpop.blueprints.Vertex;

/**
 * Interface storing the names of some legacy index names
 * @author ndx
 *
 */
public enum IndexNames {

	/**
	 * Legacy vertex index
	 */
	VERTICES("vertices", Vertex.class, true),
	/**
	 * Legacy edge index
	 */
	EDGES("edges", Edge.class, false /* see https://github.com/Riduidel/gaedo/issues/59 */);

	private final String indexName;
	private final Class indexed;
	/**
	 * Indicates this index can be used. This is a side effect of https://github.com/Riduidel/gaedo/issues/59
	 */
	private final boolean usable;

	private IndexNames(String indexName, Class indexed, boolean usable) {
		this.indexName = indexName;
		this.indexed = indexed;
		this.usable = usable;
	}

	/**
	 * @return the indexName
	 * @category getter
	 * @category indexName
	 */
	public String getIndexName() {
		return indexName;
	}

	/**
	 * @return the indexed
	 * @category getter
	 * @category indexed
	 */
	public Class getIndexed() {
		return indexed;
	}

	public String describe() {
		StringBuilder sOut = new StringBuilder();
		sOut.append(indexName).append(" indexing ").append(indexed.getName());
		return sOut.toString();
	}

	public static Collection usableIndices() {
		Collection returned = new LinkedList();
		for(IndexNames index : values()) {
			if(index.usable)
				returned.add(index);
		}
		return returned;
	}

	public static  IndexNames forElement(Type element) {
		if(element instanceof Vertex)
			return VERTICES;
		else if(element instanceof Edge)
			return EDGES;
		throw new UnsupportedElementTypeException("we have no index for elements of type "+element.getClass().getName());
	}

	/**
	 * @return the usable
	 * @category getter
	 * @category usable
	 */
	public boolean isUsable() {
		return usable;
	}
}