Package org.apache.graphar.util

Interface GrapharStaticFunctions

public interface GrapharStaticFunctions

Field Summary

Fields

Modifier and Type	Field	Description
static GrapharStaticFunctions	INSTANCE

Method Summary

Modifier and Type	Method	Description
StdSharedPtr<DataType>	booleanType()
Result<StdSharedPtr<AdjListArrowChunkReader>>	constructAdjListArrowChunkReader(StdSharedPtr<GraphInfo> graphInfo, StdString srcLabel, StdString edgeLabel, StdString dstLabel, AdjListType adjListType)	Helper function to Construct AdjListArrowChunkReader.
Result<StdSharedPtr<AdjListChunkInfoReader>>	constructAdjListChunkInfoReader(StdSharedPtr<GraphInfo> graphInfo, StdString srcLabel, StdString edgeLabel, StdString dstLabel, AdjListType adjListType)	Helper function to Construct AdjListChunkInfoReader.
Result<StdSharedPtr<AdjListOffsetArrowChunkReader>>	constructAdjListOffsetArrowChunkReader(StdSharedPtr<GraphInfo> graphInfo, StdString srcLabel, StdString edgeLabel, StdString dstLabel, AdjListType adjListType)	Helper function to Construct AdjListOffsetArrowChunkReader.
Result<StdSharedPtr<AdjListPropertyArrowChunkReader>>	constructAdjListPropertyArrowChunkReader(StdSharedPtr<GraphInfo> graphInfo, StdString srcLabel, StdString edgeLabel, StdString dstLabel, StdSharedPtr<PropertyGroup> propertyGroup, AdjListType adjListType)	Helper function to Construct AdjListPropertyArrowChunkReader.
Result<StdSharedPtr<AdjListPropertyChunkInfoReader>>	constructAdjListPropertyChunkInfoReader(StdSharedPtr<GraphInfo> graphInfo, StdString srcLabel, StdString edgeLabel, StdString dstLabel, StdSharedPtr<PropertyGroup> propertyGroup, AdjListType adjListType)	Helper function to Construct AdjListPropertyChunkInfoReader.
Result<StdSharedPtr<EdgesCollection>>	constructEdgesCollection(StdSharedPtr<GraphInfo> graphInfo, StdString srcLabel, StdString edgeLabel, StdString dstLabel, AdjListType adjListType)	Construct the collection for a range of edges.
Result<StdSharedPtr<EdgesCollection>>	constructEdgesCollection(StdSharedPtr<GraphInfo> graphInfo, StdString srcLabel, StdString edgeLabel, StdString dstLabel, AdjListType adjListType, @com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long vertexChunkBegin, @com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long vertexChunkEnd)	Construct the collection for a range of edges.
Result<StdSharedPtr<VertexPropertyArrowChunkReader>>	constructVertexPropertyArrowChunkReader(StdSharedPtr<GraphInfo> graphInfo, StdString label, StdSharedPtr<PropertyGroup> propertyGroup)	Helper function to Construct VertexPropertyArrowChunkReader.
Result<StdSharedPtr<VertexPropertyChunkInfoReader>>	constructVertexPropertyChunkInfoReader(StdSharedPtr<GraphInfo> graphInfo, StdString label, StdSharedPtr<PropertyGroup> propertyGroup)	Helper function to Construct VertexPropertyChunkInfoReader.
Result<StdSharedPtr<VerticesCollection>>	constructVerticesCollection(StdSharedPtr<GraphInfo> graphInfo, StdString label)	Construct the collection for vertices with specific label.
StdSharedPtr<AdjacentList>	createAdjacentList(AdjListType adjListType, FileType fileType)
StdSharedPtr<AdjacentList>	createAdjacentList(AdjListType adjListType, FileType fileType, StdString prefix)
StdSharedPtr<EdgeInfo>	createEdgeInfo(StdString srcLabel, StdString edgeLabel, StdString dstLabel, @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long chunkSize, @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long srcChunkSize, @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long dstChunkSize, @com.alibaba.fastffi.CXXValue boolean directed, StdVector<StdSharedPtr<AdjacentList>> adjacentLists, StdVector<StdSharedPtr<PropertyGroup>> propertyGroups)
StdSharedPtr<EdgeInfo>	createEdgeInfo(StdString srcLabel, StdString edgeLabel, StdString dstLabel, @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long chunkSize, @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long srcChunkSize, @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long dstChunkSize, @com.alibaba.fastffi.CXXValue boolean directed, StdVector<StdSharedPtr<AdjacentList>> adjacentLists, StdVector<StdSharedPtr<PropertyGroup>> propertyGroups, StdString prefix)
StdSharedPtr<EdgeInfo>	createEdgeInfo(StdString srcLabel, StdString edgeLabel, StdString dstLabel, @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long chunkSize, @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long srcChunkSize, @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long dstChunkSize, @com.alibaba.fastffi.CXXValue boolean directed, StdVector<StdSharedPtr<AdjacentList>> adjacentLists, StdVector<StdSharedPtr<PropertyGroup>> propertyGroups, StdString prefix, StdSharedPtr<InfoVersion> version)
StdSharedPtr<GraphInfo>	createGraphInfo(StdString name, StdVector<StdSharedPtr<VertexInfo>> vertexInfos, StdVector<StdSharedPtr<EdgeInfo>> edgeInfos, StdString prefix)
StdSharedPtr<GraphInfo>	createGraphInfo(StdString name, StdVector<StdSharedPtr<VertexInfo>> vertexInfos, StdVector<StdSharedPtr<EdgeInfo>> edgeInfos, StdString prefix, StdSharedPtr<InfoVersion> version)
StdSharedPtr<PropertyGroup>	createPropertyGroup(StdVector<Property> properties, FileType fileType)
StdSharedPtr<PropertyGroup>	createPropertyGroup(StdVector<Property> properties, FileType fileType, StdString prefix)
StdSharedPtr<VertexInfo>	createVertexInfo(StdString label, @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long chunk_size, StdVector<StdSharedPtr<PropertyGroup>> propertyGroups)
StdSharedPtr<VertexInfo>	createVertexInfo(StdString label, @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long chunk_size, StdVector<StdSharedPtr<PropertyGroup>> propertyGroups, StdString prefix)
StdSharedPtr<VertexInfo>	createVertexInfo(StdString label, @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long chunk_size, StdVector<StdSharedPtr<PropertyGroup>> propertyGroups, StdString prefix, StdSharedPtr<InfoVersion> version)
StdSharedPtr<DataType>	dateType()
StdSharedPtr<DataType>	float32Type()
StdSharedPtr<DataType>	float64Type()
StdSharedPtr<DataType>	int32Type()
StdSharedPtr<DataType>	int64Type()
StdSharedPtr<DataType>	stringType()
StdSharedPtr<DataType>	timestampType()

Field Detail

INSTANCE

static final GrapharStaticFunctions INSTANCE

Method Detail

constructVertexPropertyChunkInfoReader

Result<StdSharedPtr<VertexPropertyChunkInfoReader>> constructVertexPropertyChunkInfoReader(StdSharedPtr<GraphInfo> graphInfo,
                                                                                           StdString label,
                                                                                           StdSharedPtr<PropertyGroup> propertyGroup)

Helper function to Construct VertexPropertyChunkInfoReader.

Parameters:

graphInfo - The graph info to describe the graph.

label - label name of the vertex.

propertyGroup - The property group of the vertex.

constructAdjListPropertyChunkInfoReader

Result<StdSharedPtr<AdjListPropertyChunkInfoReader>> constructAdjListPropertyChunkInfoReader(StdSharedPtr<GraphInfo> graphInfo,
                                                                                             StdString srcLabel,
                                                                                             StdString edgeLabel,
                                                                                             StdString dstLabel,
                                                                                             StdSharedPtr<PropertyGroup> propertyGroup,
                                                                                             AdjListType adjListType)

Helper function to Construct AdjListPropertyChunkInfoReader.

Parameters:

graphInfo - The graph info to describe the graph.

srcLabel - label of source vertex.

edgeLabel - label of edge.

dstLabel - label of destination vertex.

propertyGroup - The property group of the edge.

adjListType - The adj list type for the edges.

constructAdjListChunkInfoReader

Result<StdSharedPtr<AdjListChunkInfoReader>> constructAdjListChunkInfoReader(StdSharedPtr<GraphInfo> graphInfo,
                                                                             StdString srcLabel,
                                                                             StdString edgeLabel,
                                                                             StdString dstLabel,
                                                                             AdjListType adjListType)

Helper function to Construct AdjListChunkInfoReader.

Parameters:

graphInfo - The graph info to describe the graph.

srcLabel - label of source vertex.

edgeLabel - label of edge.

dstLabel - label of destination vertex.

adjListType - The adj list type for the edges.

constructVertexPropertyArrowChunkReader

Result<StdSharedPtr<VertexPropertyArrowChunkReader>> constructVertexPropertyArrowChunkReader(StdSharedPtr<GraphInfo> graphInfo,
                                                                                             StdString label,
                                                                                             StdSharedPtr<PropertyGroup> propertyGroup)

Helper function to Construct VertexPropertyArrowChunkReader.

Parameters:

graphInfo - The graph info to describe the graph.

label - label of the vertex.

propertyGroup - The property group of the vertex.

constructAdjListArrowChunkReader

Result<StdSharedPtr<AdjListArrowChunkReader>> constructAdjListArrowChunkReader(StdSharedPtr<GraphInfo> graphInfo,
                                                                               StdString srcLabel,
                                                                               StdString edgeLabel,
                                                                               StdString dstLabel,
                                                                               AdjListType adjListType)

Helper function to Construct AdjListArrowChunkReader.

Parameters:

graphInfo - The graph info to describe the graph.

srcLabel - label of source vertex.

edgeLabel - label of edge.

dstLabel - label of destination vertex.

adjListType - The adj list type for the edges.

constructAdjListOffsetArrowChunkReader

Result<StdSharedPtr<AdjListOffsetArrowChunkReader>> constructAdjListOffsetArrowChunkReader(StdSharedPtr<GraphInfo> graphInfo,
                                                                                           StdString srcLabel,
                                                                                           StdString edgeLabel,
                                                                                           StdString dstLabel,
                                                                                           AdjListType adjListType)

Helper function to Construct AdjListOffsetArrowChunkReader.

Parameters:

graphInfo - The graph info to describe the graph.

srcLabel - label of source vertex.

edgeLabel - label of edge.

dstLabel - label of destination vertex.

adjListType - The adj list type for the edges.

constructAdjListPropertyArrowChunkReader

Result<StdSharedPtr<AdjListPropertyArrowChunkReader>> constructAdjListPropertyArrowChunkReader(StdSharedPtr<GraphInfo> graphInfo,
                                                                                               StdString srcLabel,
                                                                                               StdString edgeLabel,
                                                                                               StdString dstLabel,
                                                                                               StdSharedPtr<PropertyGroup> propertyGroup,
                                                                                               AdjListType adjListType)

Helper function to Construct AdjListPropertyArrowChunkReader.

Parameters:

graphInfo - The graph info to describe the graph.

srcLabel - label of source vertex.

edgeLabel - label of edge.

dstLabel - label of destination vertex.

propertyGroup - The property group of the edge.

adjListType - The adj list type for the edges.

constructVerticesCollection

Result<StdSharedPtr<VerticesCollection>> constructVerticesCollection(StdSharedPtr<GraphInfo> graphInfo,
                                                                     StdString label)

Construct the collection for vertices with specific label.

Parameters:

graphInfo - The GraphInfo for the graph.

label - The vertex label.

Returns:

The constructed collection or error.

constructEdgesCollection

Result<StdSharedPtr<EdgesCollection>> constructEdgesCollection(StdSharedPtr<GraphInfo> graphInfo,
                                                               StdString srcLabel,
                                                               StdString edgeLabel,
                                                               StdString dstLabel,
                                                               AdjListType adjListType,
                                                               @com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long vertexChunkBegin,
                                                               @com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long vertexChunkEnd)

Construct the collection for a range of edges.

Parameters:

graphInfo - The GraphInfo for the graph.

srcLabel - The source vertex label.

edgeLabel - The edge label.

dstLabel - The destination vertex label.

adjListType - The adjList type.

vertexChunkBegin - The index of the beginning vertex chunk.

vertexChunkEnd - The index of the end vertex chunk (not included).

Returns:

The constructed collection or error.

constructEdgesCollection

Result<StdSharedPtr<EdgesCollection>> constructEdgesCollection(StdSharedPtr<GraphInfo> graphInfo,
                                                               StdString srcLabel,
                                                               StdString edgeLabel,
                                                               StdString dstLabel,
                                                               AdjListType adjListType)

Construct the collection for a range of edges.

Parameters:

graphInfo - The GraphInfo for the graph.

srcLabel - The source vertex label.

edgeLabel - The edge label.

dstLabel - The destination vertex label.

adjListType - The adjList type.

Returns:

The constructed collection or error.

createPropertyGroup

StdSharedPtr<PropertyGroup> createPropertyGroup(StdVector<Property> properties,
                                                FileType fileType,
                                                StdString prefix)

createPropertyGroup

StdSharedPtr<PropertyGroup> createPropertyGroup(StdVector<Property> properties,
                                                FileType fileType)

createAdjacentList

StdSharedPtr<AdjacentList> createAdjacentList(AdjListType adjListType,
                                              FileType fileType,
                                              StdString prefix)

createAdjacentList

StdSharedPtr<AdjacentList> createAdjacentList(AdjListType adjListType,
                                              FileType fileType)

createVertexInfo

StdSharedPtr<VertexInfo> createVertexInfo(StdString label,
                                          @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long chunk_size,
                                          StdVector<StdSharedPtr<PropertyGroup>> propertyGroups,
                                          StdString prefix,
                                          StdSharedPtr<InfoVersion> version)

createVertexInfo

StdSharedPtr<VertexInfo> createVertexInfo(StdString label,
                                          @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long chunk_size,
                                          StdVector<StdSharedPtr<PropertyGroup>> propertyGroups,
                                          StdString prefix)

createVertexInfo

StdSharedPtr<VertexInfo> createVertexInfo(StdString label,
                                          @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long chunk_size,
                                          StdVector<StdSharedPtr<PropertyGroup>> propertyGroups)

createEdgeInfo

StdSharedPtr<EdgeInfo> createEdgeInfo(StdString srcLabel,
                                      StdString edgeLabel,
                                      StdString dstLabel,
                                      @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long chunkSize,
                                      @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long srcChunkSize,
                                      @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long dstChunkSize,
                                      @com.alibaba.fastffi.CXXValue boolean directed,
                                      StdVector<StdSharedPtr<AdjacentList>> adjacentLists,
                                      StdVector<StdSharedPtr<PropertyGroup>> propertyGroups,
                                      StdString prefix,
                                      StdSharedPtr<InfoVersion> version)

createEdgeInfo

StdSharedPtr<EdgeInfo> createEdgeInfo(StdString srcLabel,
                                      StdString edgeLabel,
                                      StdString dstLabel,
                                      @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long chunkSize,
                                      @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long srcChunkSize,
                                      @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long dstChunkSize,
                                      @com.alibaba.fastffi.CXXValue boolean directed,
                                      StdVector<StdSharedPtr<AdjacentList>> adjacentLists,
                                      StdVector<StdSharedPtr<PropertyGroup>> propertyGroups,
                                      StdString prefix)

createEdgeInfo

StdSharedPtr<EdgeInfo> createEdgeInfo(StdString srcLabel,
                                      StdString edgeLabel,
                                      StdString dstLabel,
                                      @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long chunkSize,
                                      @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long srcChunkSize,
                                      @com.alibaba.fastffi.CXXValue,@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long dstChunkSize,
                                      @com.alibaba.fastffi.CXXValue boolean directed,
                                      StdVector<StdSharedPtr<AdjacentList>> adjacentLists,
                                      StdVector<StdSharedPtr<PropertyGroup>> propertyGroups)

createGraphInfo

StdSharedPtr<GraphInfo> createGraphInfo(StdString name,
                                        StdVector<StdSharedPtr<VertexInfo>> vertexInfos,
                                        StdVector<StdSharedPtr<EdgeInfo>> edgeInfos,
                                        StdString prefix,
                                        StdSharedPtr<InfoVersion> version)

createGraphInfo

StdSharedPtr<GraphInfo> createGraphInfo(StdString name,
                                        StdVector<StdSharedPtr<VertexInfo>> vertexInfos,
                                        StdVector<StdSharedPtr<EdgeInfo>> edgeInfos,
                                        StdString prefix)

booleanType

StdSharedPtr<DataType> booleanType()

int32Type

StdSharedPtr<DataType> int32Type()

int64Type

StdSharedPtr<DataType> int64Type()

float32Type

StdSharedPtr<DataType> float32Type()

float64Type

StdSharedPtr<DataType> float64Type()

stringType

StdSharedPtr<DataType> stringType()

dateType

StdSharedPtr<DataType> dateType()

timestampType

StdSharedPtr<DataType> timestampType()