/*
*
* * Copyright 2014 Orient Technologies LTD (info(at)orientechnologies.com)
* *
* * 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.
* *
* * For more information: http://www.orientechnologies.com
*
*/
package com.tinkerpop.blueprints.impls.orient;
import com.orientechnologies.orient.core.command.OCommandRequest;
import com.orientechnologies.orient.core.command.traverse.OTraverse;
import com.orientechnologies.orient.core.conflict.ORecordConflictStrategy;
import com.orientechnologies.orient.core.db.document.ODatabaseDocumentTx;
import com.orientechnologies.orient.core.intent.OIntent;
import com.orientechnologies.orient.core.metadata.schema.OClass;
import com.tinkerpop.blueprints.*;
/**
* OrientDB extension to Blueprints standard.
*
* @author Luca Garulli (http://www.orientechnologies.com)
*/
public interface OrientExtendedGraph extends IndexableGraph, MetaGraph<ODatabaseDocumentTx>, KeyIndexableGraph {
/**
* (Blueprints Extension) Drops the database
*/
void drop();
/**
* (Blueprints Extension) Creates a temporary vertex setting the initial field values. The vertex is not saved and the transaction
* is not started.
*
* @param iClassName
* Vertex's class name
* @param prop
* Fields must be a odd pairs of key/value or a single object as Map containing entries as key/value pairs
* @return added vertex
*/
OrientVertex addTemporaryVertex(String iClassName, Object... prop);
/**
* (Blueprints Extension) Creates a new unconnected vertex in the Graph setting the initial field values.
*
* @param id
* Optional, can contains the Edge's class name by prefixing with "class:"
* @param prop
* Fields must be a odd pairs of key/value or a single object as Map containing entries as key/value pairs
* @return The new OrientVertex created
*/
Vertex addVertex(Object id, Object... prop);
/**
* Returns the V persistent class as OrientVertexType instance.
*/
OrientVertexType getVertexBaseType();
/**
* Returns the persistent class for type iTypeName as OrientVertexType instance.
*
* @param iTypeName
* Vertex class name
*/
OrientVertexType getVertexType(String iTypeName);
/**
* Creates a new Vertex persistent class.
*
* @param iClassName
* Vertex class name
* @return OrientVertexType instance representing the persistent class
*/
OrientVertexType createVertexType(String iClassName);
/**
* Creates a new Vertex persistent class.
*
* @param iClassName
* Vertex class name
* @param clusters
* The number of clusters to create for the new class. By default the MINIMUMCLUSTERS database setting is used. In v2.2
* and later, the number of clusters are proportioned to the amount of cores found on the machine
* @return OrientVertexType instance representing the persistent class
*/
OrientVertexType createVertexType(String iClassName, int clusters);
/**
* Creates a new Vertex persistent class specifying the super class.
*
* @param iClassName
* Vertex class name
* @param iSuperClassName
* Vertex class name to extend
* @return OrientVertexType instance representing the persistent class
*/
OrientVertexType createVertexType(String iClassName, String iSuperClassName);
/**
* Creates a new Vertex persistent class specifying the super class.
*
* @param iClassName
* Vertex class name
* @param iSuperClassName
* Vertex class name to extend
* @param clusters
* The number of clusters to create for the new class. By default the MINIMUMCLUSTERS database setting is used. In v2.2
* and later, the number of clusters are proportioned to the amount of cores found on the machine
* @return OrientVertexType instance representing the persistent class
*/
OrientVertexType createVertexType(String iClassName, String iSuperClassName, int clusters);
/**
* Creates a new Vertex persistent class specifying the super class.
*
* @param iClassName
* Vertex class name
* @param iSuperClass
* OClass Vertex to extend
* @return OrientVertexType instance representing the persistent class
*/
OrientVertexType createVertexType(String iClassName, OClass iSuperClass);
/**
* Creates a new Vertex persistent class specifying the super class.
*
* @param iClassName
* Vertex class name
* @param iSuperClass
* OClass Vertex to extend
* @param clusters
* The number of clusters to create for the new class. By default the MINIMUMCLUSTERS database setting is used. In v2.2
* and later, the number of clusters are proportioned to the amount of cores found on the machine
* @return OrientVertexType instance representing the persistent class
*/
OrientVertexType createVertexType(String iClassName, OClass iSuperClass, int clusters);
/**
* Drop a vertex class.
*
* @param iTypeName
* Vertex class name
*/
void dropVertexType(String iTypeName);
/**
* Returns the E persistent class as OrientEdgeType instance.
*/
OrientEdgeType getEdgeBaseType();
/**
* Returns the persistent class for type iTypeName as OrientEdgeType instance.
*
* @param iTypeName
* Edge class name
*/
OrientEdgeType getEdgeType(String iTypeName);
/**
* Creates a new Edge persistent class.
*
* @param iClassName
* Edge class name
* @return OrientEdgeType instance representing the persistent class
*/
OrientEdgeType createEdgeType(String iClassName);
/**
* Creates a new Edge persistent class specifying the super class.
*
* @param iClassName
* Edge class name
* @param iSuperClassName
* Edge class name to extend
* @return OrientEdgeType instance representing the persistent class
*/
OrientEdgeType createEdgeType(String iClassName, String iSuperClassName);
/**
* Creates a new Edge persistent class specifying the super class.
*
* @param iClassName
* Edge class name
* @param iSuperClass
* OClass Edge to extend
* @return OrientEdgeType instance representing the persistent class
*/
OrientEdgeType createEdgeType(String iClassName, OClass iSuperClass);
/**
* Creates a new Edge persistent class specifying the super class.
*
* @param iClassName
* Edge class name
* @param iSuperClass
* OClass Edge to extend
* @param clusters
* The number of clusters to create for the new class. By default the MINIMUMCLUSTERS database setting is used. In v2.2
* and later, the number of clusters are proportioned to the amount of cores found on the machine
* @return OrientEdgeType instance representing the persistent class
*/
OrientEdgeType createEdgeType(String iClassName, OClass iSuperClass, int clusters);
/**
* Drops an edge class.
*
* @param iTypeName
* Edge class name
*/
void dropEdgeType(String iTypeName);
/**
* Detaches a Graph Element to be used offline. All the changes will be committed on further @attach call.
*
* @param iElement
* Graph element to detach
* @return The detached element
* @see #attach(OrientElement)
*/
OrientElement detach(OrientElement iElement);
/**
* Attaches a previously detached Graph Element to the current Graph. All the pending changes will be committed.
*
* @param iElement
* Graph element to attach
* @return The attached element
* @see #detach(OrientElement)
*/
OrientElement attach(OrientElement iElement);
/**
* Returns a GraphQuery object to execute queries against the Graph.
*
* @return new GraphQuery instance
*/
@Override
GraphQuery query();
/**
* Returns a OTraverse object to start traversing the graph.
*/
OTraverse traverse();
/**
* Executes commands against the graph. Commands are executed outside transaction.
*
* @param iCommand
* Command request between SQL, GREMLIN and SCRIPT commands
*/
OCommandRequest command(OCommandRequest iCommand);
/**
* Counts the vertices in graph.
*
* @return Long as number of total vertices
*/
long countVertices();
/**
* Counts the vertices in graph of a particular class.
*
* @return Long as number of total vertices
*/
long countVertices(String iClassName);
/**
* Counts the edges in graph. Edge counting works only if useLightweightEdges is false.
*
* @return Long as number of total edges
*/
long countEdges();
/**
* Counts the edges in graph of a particular class. Edge counting works only if useLightweightEdges is false.
*
* @return Long as number of total edges
*/
long countEdges(String iClassName);
/**
* Declare an intent.
*/
void declareIntent(OIntent iIntent);
ORecordConflictStrategy getConflictStrategy();
OrientExtendedGraph setConflictStrategy(ORecordConflictStrategy iResolver);
OrientExtendedGraph setConflictStrategy(String iStrategyName);
}