AOSharedServiceLibrary
Public Member Functions | List of all members
DbObjectInterface Class Referenceabstract

A Neo4j Object. More...

#include <neo4j_interface.h>

Public Member Functions

virtual bool is_node ()=0
 Is this a node? More...
 
virtual bool is_edge ()=0
 Is this an edge? More...
 
virtual bool is_path ()=0
 Is this a path? More...
 
virtual std::string to_string ()=0
 Get the string representation of the object.
 
virtual DbMapInterfaceproperties ()=0
 Get the properties of the object. More...
 
virtual DbListInterfacelabels ()=0
 Get the labels of the node. More...
 
virtual std::string type ()=0
 Get the type of the edge. More...
 
virtual bool forward ()=0
 Was the edge traversed in it's natural direction? More...
 
virtual unsigned int size ()=0
 Get the size of the path. More...
 
virtual DbObjectInterfaceget_path_element (int path_index)=0
 Get an element from a path object. More...
 

Detailed Description

A Neo4j Object.

This is returned from a result tree and represents either a node, an edge, or a path

Member Function Documentation

virtual bool DbObjectInterface::forward ( )
pure virtual

Was the edge traversed in it's natural direction?

This functions only for edge objects which were taken from a Path

virtual DbObjectInterface* DbObjectInterface::get_path_element ( int  path_index)
pure virtual

Get an element from a path object.

Get an element from a path at the specified index. This functions only for path objects

virtual bool DbObjectInterface::is_edge ( )
pure virtual

Is this an edge?

Return false if this is a node or path object. Return true if this is an edge object.

virtual bool DbObjectInterface::is_node ( )
pure virtual

Is this a node?

Return true if this is a node object. Return false if this is an edge or path object.

virtual bool DbObjectInterface::is_path ( )
pure virtual

Is this a path?

Return false if this is a node or edge object. Return true if this is a path object.

virtual DbListInterface* DbObjectInterface::labels ( )
pure virtual

Get the labels of the node.

This functions only for node objects

virtual DbMapInterface* DbObjectInterface::properties ( )
pure virtual

Get the properties of the object.

This functions for both node objects and edge objects

virtual unsigned int DbObjectInterface::size ( )
pure virtual

Get the size of the path.

This functions only for path objects

virtual std::string DbObjectInterface::type ( )
pure virtual

Get the type of the edge.

This functions only for edge objects


The documentation for this class was generated from the following file: