org.apache.tinkerpop.gremlin.orientdb.OrientVertex Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of orientdb-gremlin Show documentation
Show all versions of orientdb-gremlin Show documentation
TinkerPop3 Graph Structure Implementation for OrientDB
package org.apache.tinkerpop.gremlin.orientdb;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Strings.isNullOrEmpty;
import static org.apache.tinkerpop.gremlin.orientdb.StreamUtils.asStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.tinkerpop.gremlin.structure.Direction;
import org.apache.tinkerpop.gremlin.structure.Edge;
import org.apache.tinkerpop.gremlin.structure.Property;
import org.apache.tinkerpop.gremlin.structure.Vertex;
import org.apache.tinkerpop.gremlin.structure.VertexProperty;
import org.apache.tinkerpop.gremlin.structure.util.ElementHelper;
import org.apache.tinkerpop.gremlin.structure.util.StringFactory;
import com.orientechnologies.common.util.OPair;
import com.orientechnologies.orient.core.db.record.OIdentifiable;
import com.orientechnologies.orient.core.db.record.ORecordElement;
import com.orientechnologies.orient.core.db.record.ORecordLazyList;
import com.orientechnologies.orient.core.db.record.ridbag.ORidBag;
import com.orientechnologies.orient.core.metadata.schema.OClass;
import com.orientechnologies.orient.core.metadata.schema.OImmutableClass;
import com.orientechnologies.orient.core.metadata.schema.OProperty;
import com.orientechnologies.orient.core.metadata.schema.OType;
import com.orientechnologies.orient.core.record.impl.ODocument;
import com.orientechnologies.orient.core.record.impl.ODocumentInternal;
public final class OrientVertex extends OrientElement implements Vertex {
public static final String CONNECTION_OUT_PREFIX = OrientGraphUtils.CONNECTION_OUT + "_";
public static final String CONNECTION_IN_PREFIX = OrientGraphUtils.CONNECTION_IN + "_";
private static final List INTERNAL_FIELDS = Arrays.asList("@rid", "@class");
public OrientVertex(final OrientGraph graph, final OIdentifiable rawElement) {
super(graph, rawElement);
}
public OrientVertex(OrientGraph graph, String className) {
this(graph, createRawElement(graph, className));
}
protected static ODocument createRawElement(OrientGraph graph, String className) {
graph.createVertexClass(className);
return new ODocument(className);
}
public Iterator vertices(final Direction direction, final String... labels) {
final ODocument doc = getRawDocument();
final List> streamVertices = new ArrayList<>();
for (String fieldName : doc.fieldNames()) {
final OPair connection = getConnection(direction, fieldName, labels);
if (connection == null)
// SKIP THIS FIELD
continue;
final Object fieldValue = doc.field(fieldName);
if (fieldValue == null)
continue;
if (fieldValue instanceof ORidBag)
streamVertices.add(asStream(((ORidBag) fieldValue).rawIterator())
.map(oIdentifiable -> new OrientEdge(graph, oIdentifiable.getRecord()))
.map(edge -> edge.vertices(direction.opposite()))
.flatMap(vertices -> asStream(vertices)));
else
throw new IllegalStateException("Invalid content found in " + fieldName + " field: " + fieldValue);
}
return streamVertices.stream()
.flatMap(vertices -> vertices)
.iterator();
}
public Iterator> properties(final String... propertyKeys) {
Iterator> properties = super.properties(propertyKeys);
return StreamUtils.asStream(properties)
.filter(p -> !INTERNAL_FIELDS.contains(p.key()))
.filter(p -> !p.key().startsWith("out_"))
.filter(p -> !p.key().startsWith("in_"))
.filter(p -> !p.key().startsWith("_meta_"))
.map(p -> (VertexProperty) new OrientVertexProperty<>(p.key(), p.value(), (OrientVertex) p.element())).iterator();
}
@Override
public VertexProperty property(final String key, final V value) {
return new OrientVertexProperty<>(super.property(key, value), this);
}
@Override
public VertexProperty property(final String key, final V value, final Object... keyValues) {
VertexProperty vertexProperty = this.property(key, value);
if (ElementHelper.getIdValue(keyValues).isPresent())
throw VertexProperty.Exceptions.userSuppliedIdsNotSupported();
ElementHelper.legalPropertyKeyValueArray(keyValues);
ElementHelper.attachProperties(vertexProperty, keyValues);
return vertexProperty;
}
@Override
public VertexProperty property(
final VertexProperty.Cardinality cardinality,
final String key,
final V value,
final Object... keyValues) {
return this.property(key, value, keyValues);
}
@Override
public String toString() {
return StringFactory.vertexString(this);
}
@Override
public Edge addEdge(String label, Vertex inVertex, Object... keyValues) {
if (inVertex == null)
throw new IllegalArgumentException("destination vertex is null");
checkArgument(!isNullOrEmpty(label), "label is invalid");
ElementHelper.legalPropertyKeyValueArray(keyValues);
if (ElementHelper.getIdValue(keyValues).isPresent()) throw Vertex.Exceptions.userSuppliedIdsNotSupported();
final ODocument outDocument = getRawDocument();
if (!outDocument.getSchemaClass().isSubClassOf(OImmutableClass.VERTEX_CLASS_NAME))
throw new IllegalArgumentException("source record is not a vertex");
final ODocument inDocument = ((OrientVertex) inVertex).getRawDocument();
if (!inDocument.getSchemaClass().isSubClassOf(OImmutableClass.VERTEX_CLASS_NAME))
throw new IllegalArgumentException("destination record is not a vertex");
final OrientEdge edge;
label = OrientGraphUtils.encodeClassName(label);
final String outFieldName = getConnectionFieldName(Direction.OUT, label);
final String inFieldName = getConnectionFieldName(Direction.IN, label);
// since the label for the edge can potentially get re-assigned
// before being pushed into the OrientEdge, the null check has to go
// here.
if (label == null)
throw new IllegalStateException("label cannot be null");
// CREATE THE EDGE DOCUMENT TO STORE FIELDS TOO
String className = graph.labelToClassName(label, OImmutableClass.EDGE_CLASS_NAME);
edge = new OrientEdge(graph, className, outDocument, inDocument, label);
edge.property(keyValues);
edge.getRawDocument().fields(OrientGraphUtils.CONNECTION_OUT, rawElement, OrientGraphUtils.CONNECTION_IN, inDocument);
createLink(outDocument, edge.getRawElement(), outFieldName);
createLink(inDocument, edge.getRawElement(), inFieldName);
edge.save();
inDocument.save();
outDocument.save();
return edge;
}
public void remove() {
ODocument doc = getRawDocument();
if (doc.getInternalStatus() == ORecordElement.STATUS.NOT_LOADED)
doc.load();
Iterator allEdges = edges(Direction.BOTH, "E");
while (allEdges.hasNext())
allEdges.next().remove();
doc.getDatabase().delete(doc.getIdentity());
}
public static String getConnectionFieldName(final Direction iDirection, final String iClassName) {
if (iDirection == null || iDirection == Direction.BOTH)
throw new IllegalArgumentException("Direction not valid");
final String prefix = iDirection == Direction.OUT ? CONNECTION_OUT_PREFIX : CONNECTION_IN_PREFIX;
if (iClassName == null || iClassName.isEmpty() || iClassName.equals(OImmutableClass.EDGE_CLASS_NAME))
return prefix;
return prefix + iClassName;
}
// this ugly code was copied from the TP2 implementation
@SuppressWarnings("unchecked")
public Object createLink(final ODocument iFromVertex, final OIdentifiable iTo, final String iFieldName) {
final Object out;
OType outType = iFromVertex.fieldType(iFieldName);
Object found = iFromVertex.field(iFieldName);
final OClass linkClass = ODocumentInternal.getImmutableSchemaClass(iFromVertex);
if (linkClass == null)
throw new IllegalArgumentException("Class not found in source vertex: " + iFromVertex);
final OProperty prop = linkClass.getProperty(iFieldName);
final OType propType = prop != null && prop.getType() != OType.ANY ? prop.getType() : null;
if (found == null) {
if (propType == null || propType == OType.LINKBAG) {
final ORidBag bag = new ORidBag();
bag.add(iTo);
out = bag;
outType = OType.LINKBAG;
} else
throw new IllegalStateException("Type of field provided in schema '" + prop.getType() + "' can not be used for link creation.");
} else if (found instanceof OIdentifiable) {
if (prop != null && propType == OType.LINK)
throw new IllegalStateException("Type of field provided in schema '" + prop.getType() + "' can not be used for creation to hold several links.");
if (prop != null && "true".equalsIgnoreCase(prop.getCustom("ordered"))) {
final Collection coll = new ORecordLazyList(iFromVertex);
coll.add((OIdentifiable) found);
coll.add(iTo);
out = coll;
outType = OType.LINKLIST;
} else {
final ORidBag bag = new ORidBag();
bag.add((OIdentifiable) found);
bag.add(iTo);
out = bag;
outType = OType.LINKBAG;
}
} else if (found instanceof ORidBag) {
// ADD THE LINK TO THE COLLECTION
out = null;
((ORidBag) found).add(iTo);
} else if (found instanceof Collection) {
// USE THE FOUND COLLECTION
out = null;
((Collection) found).add(iTo);
} else
throw new IllegalStateException("Relationship content is invalid on field " + iFieldName + ". Found: " + found);
if (out != null)
// OVERWRITE IT
iFromVertex.field(iFieldName, out, outType);
return out;
}
public Iterator edges(final Direction direction, String... edgeLabels) {
final ODocument doc = getRawDocument();
final List> streamVertices = new ArrayList<>();
for (String fieldName : doc.fieldNames()) {
final OPair connection = getConnection(direction, fieldName, edgeLabels);
if (connection == null)
// SKIP THIS FIELD
continue;
final Object fieldValue = doc.field(fieldName);
if (fieldValue == null)
continue;
if (fieldValue instanceof ORidBag)
streamVertices.add(asStream(((ORidBag) fieldValue).iterator()).collect(Collectors.toList()));
else
throw new IllegalStateException("Invalid content found in " + fieldName + " field: " + fieldValue);
}
return streamVertices.stream()
.flatMap(edges -> edges.stream())
.filter(oId -> oId != null)
.map(oIdentifiable -> new OrientEdge(graph, oIdentifiable.getRecord()))
.map(edge -> (Edge) edge)
.iterator();
}
/**
* Determines if a field is a connections or not.
*
* @param iDirection
* Direction to check
* @param iFieldName
* Field name
* @param iClassNames
* Optional array of class names
* @return The found direction if any
*/
protected OPair getConnection(final Direction iDirection, final String iFieldName, String... iClassNames) {
if (iClassNames != null && iClassNames.length == 1 && iClassNames[0].equalsIgnoreCase("E"))
// DEFAULT CLASS, TREAT IT AS NO CLASS/LABEL
iClassNames = null;
if (iDirection == Direction.OUT || iDirection == Direction.BOTH) {
// FIELDS THAT STARTS WITH "out_"
if (iFieldName.startsWith(CONNECTION_OUT_PREFIX)) {
if (iClassNames == null || iClassNames.length == 0)
return new OPair(Direction.OUT, getConnectionClass(Direction.OUT, iFieldName));
// CHECK AGAINST ALL THE CLASS NAMES
for (String clsName : iClassNames) {
clsName = OrientGraphUtils.encodeClassName(clsName);
if (iFieldName.equals(CONNECTION_OUT_PREFIX + clsName))
return new OPair(Direction.OUT, clsName);
}
}
}
if (iDirection == Direction.IN || iDirection == Direction.BOTH) {
// FIELDS THAT STARTS WITH "in_"
if (iFieldName.startsWith(CONNECTION_IN_PREFIX)) {
if (iClassNames == null || iClassNames.length == 0)
return new OPair(Direction.IN, getConnectionClass(Direction.IN, iFieldName));
// CHECK AGAINST ALL THE CLASS NAMES
for (String clsName : iClassNames) {
if (iFieldName.equals(CONNECTION_IN_PREFIX + clsName))
return new OPair(Direction.IN, clsName);
}
}
}
// NOT FOUND
return null;
}
/**
* Used to extract the class name from the vertex's field.
*
* @param iDirection
* Direction of connection
* @param iFieldName
* Full field name
* @return Class of the connection if any
*/
public String getConnectionClass(final Direction iDirection, final String iFieldName) {
if (iDirection == Direction.OUT) {
if (iFieldName.length() > CONNECTION_OUT_PREFIX.length())
return iFieldName.substring(CONNECTION_OUT_PREFIX.length());
} else if (iDirection == Direction.IN) {
if (iFieldName.length() > CONNECTION_IN_PREFIX.length())
return iFieldName.substring(CONNECTION_IN_PREFIX.length());
}
return OImmutableClass.EDGE_CLASS_NAME;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy