+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you 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.
+
+# copyright 2022-2023 alibaba group holding limited.
+#
+# 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.
+
+"""Bindings to com.alibaba.graphar info classes."""
+
+# because we are using type-hints, we need to define few custom TypeVar
+# to describe returns of classmethods;
+
+from __future__ import annotations
+
+import os
+from collections.abc import Sequence
+from typing import Optional, TypeVar, Union
+
+from py4j.java_collections import JavaList
+from py4j.java_gateway import JavaObject
+
+from graphar_pyspark import GraphArSession, _check_session
+from graphar_pyspark.enums import AdjListType, FileType, GarType
+
+# Return type of Property classmethods
+PropertyType = TypeVar("PropertyType", bound="Property")
+
+
+[docs]class Property:
+
"""The property information of vertex or edge."""
+
+
def __init__(
+
self,
+
name: Optional[str],
+
data_type: Optional[GarType],
+
is_primary: Optional[bool],
+
is_nullable: Optional[bool],
+
jvm_obj: Optional[JavaObject] = None,
+
) -> None:
+
"""One should not use this constructor directly, please use `from_scala` or `from_python`."""
+
_check_session()
+
if jvm_obj is not None:
+
self._jvm_property_obj = jvm_obj
+
else:
+
property_pyobj = GraphArSession.graphar.Property()
+
property_pyobj.setName(name)
+
property_pyobj.setData_type(data_type.value)
+
property_pyobj.setIs_primary(is_primary)
+
property_pyobj.setIs_nullable(is_nullable)
+
+
self._jvm_property_obj = property_pyobj
+
+
[docs] def get_name(self) -> str:
+
"""Get name from corresponding JVM object.
+
+
:returns: name
+
"""
+
return self._jvm_property_obj.getName()
+
+
[docs] def set_name(self, name: str) -> None:
+
"""Mutate corresponding JVM object.
+
+
:param name: name
+
"""
+
self._jvm_property_obj.setName(name)
+
+
[docs] def get_data_type(self) -> GarType:
+
"""Get data type from corresponding JVM object.
+
+
:returns: data type
+
"""
+
return GarType(self._jvm_property_obj.getData_type())
+
+
[docs] def set_data_type(self, data_type: GarType) -> None:
+
"""Mutate corresponding JVM object.
+
+
:param data_type: data type
+
"""
+
self._jvm_property_obj.setData_type(data_type.value)
+
+
[docs] def get_is_primary(self) -> bool:
+
"""Get is priamry flag from corresponding JVM object.
+
+
:returns: is primary
+
"""
+
return self._jvm_property_obj.getIs_primary()
+
+
[docs] def set_is_primary(self, is_primary: bool) -> None:
+
"""Mutate corresponding JVM object.
+
+
:param is_primary: is primary
+
"""
+
self._jvm_property_obj.setIs_primary(is_primary)
+
+
[docs] def set_is_nullable(self, is_nullable: bool) -> None:
+
"""Mutate corresponding JVM object.
+
+
:param is_nullable: is nullable
+
"""
+
self._jvm_property_obj.setIs_nullable(is_nullable)
+
+
[docs] def get_is_nullable(self) -> bool:
+
"""Get is nullable flag from corresponding JVM object.
+
+
:returns: is nullable
+
"""
+
return self._jvm_property_obj.getIs_nullable()
+
+
[docs] def to_scala(self) -> JavaObject:
+
"""Transform object to JVM representation.
+
+
:returns: JavaObject
+
"""
+
return self._jvm_property_obj
+
+
[docs] @classmethod
+
def from_scala(cls: type[PropertyType], jvm_obj: JavaObject) -> PropertyType:
+
"""Create an instance of the Class from the corresponding JVM object.
+
+
:param jvm_obj: scala object in JVM.
+
:returns: instance of Python Class.
+
"""
+
return cls(None, None, None, None, jvm_obj)
+
+
[docs] @classmethod
+
def from_python(
+
cls: type[PropertyType],
+
name: str,
+
data_type: GarType,
+
is_primary: bool,
+
is_nullable: Optional[bool] = None,
+
) -> PropertyType:
+
"""Create an instance of the Class from Python arguments.
+
+
:param name: property name
+
:param data_type: property data type
+
:param is_primary: flag that property is primary
+
:param is_nullable: flag that property is nullable (optional, default is None)
+
:returns: instance of Python Class.
+
"""
+
return cls(name, data_type, is_primary, is_nullable, None)
+
+
def __eq__(self, other: object) -> bool:
+
if not isinstance(other, Property):
+
return False
+
+
return (
+
(self.get_name() == other.get_name())
+
and (self.get_data_type() == other.get_data_type())
+
and (self.get_is_primary() == other.get_is_primary())
+
and (self.get_is_nullable() == other.get_is_nullable())
+
)
+
+
+# Return type of PropertyGroup classmethods
+PropertyGroupType = TypeVar("PropertyGroupType", bound="PropertyGroup")
+
+
+[docs]class PropertyGroup:
+
"""PropertyGroup is a class to store the property group information."""
+
+
def __init__(
+
self,
+
prefix: Optional[str],
+
file_type: Optional[FileType],
+
properties: Optional[Sequence[Property]],
+
jvm_obj: Optional[JavaObject],
+
) -> None:
+
"""One should not use this constructor directly, please use `from_scala` or `from_python`."""
+
_check_session()
+
if jvm_obj is not None:
+
self._jvm_property_group_obj = jvm_obj
+
else:
+
property_group = GraphArSession.graphar.PropertyGroup()
+
property_group.setPrefix(prefix)
+
property_group.setFile_type(file_type.value)
+
property_group.setProperties(
+
[py_property.to_scala() for py_property in properties],
+
)
+
self._jvm_property_group_obj = property_group
+
+
[docs] def get_prefix(self) -> str:
+
"""Get prefix from the corresponding JVM object.
+
+
:returns: prefix
+
"""
+
return self._jvm_property_group_obj.getPrefix()
+
+
[docs] def set_prefix(self, prefix: str) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param prefix: prefix
+
"""
+
self._jvm_property_group_obj.setPrefix(prefix)
+
+
[docs] def get_file_type(self) -> FileType:
+
"""Get file type from the corresponding JVM object.
+
+
:returns: FileType
+
"""
+
return FileType(self._jvm_property_group_obj.getFile_type())
+
+
[docs] def set_file_type(self, file_type: FileType) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param file_type: FileType
+
"""
+
self._jvm_property_group_obj.setFile_type(file_type.value)
+
+
[docs] def get_properties(self) -> Sequence[Property]:
+
"""Get properties from the corresponding JVM object.
+
+
:returns: list of Properties
+
"""
+
return [
+
Property.from_scala(jvm_property)
+
for jvm_property in self._jvm_property_group_obj.getProperties()
+
]
+
+
[docs] def set_properties(self, properties: Sequence[Property]) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param properties: list of Properties
+
"""
+
self._jvm_property_group_obj.setProperties(
+
[py_property.to_scala() for py_property in properties],
+
)
+
+
[docs] def to_scala(self) -> JavaObject:
+
"""Transform object to JVM representation.
+
+
:returns: JavaObject
+
"""
+
return self._jvm_property_group_obj
+
+
[docs] @classmethod
+
def from_scala(
+
cls: type[PropertyGroupType],
+
jvm_obj: JavaObject,
+
) -> PropertyGroupType:
+
"""Create an instance of the Class from the corresponding JVM object.
+
+
:param jvm_obj: scala object in JVM.
+
:returns: instance of Python Class.
+
"""
+
return cls(None, None, None, jvm_obj)
+
+
[docs] @classmethod
+
def from_python(
+
cls: type[PropertyGroupType],
+
prefix: str,
+
file_type: FileType,
+
properties: Sequence[Property],
+
) -> PropertyGroupType:
+
"""Create an instance of the class from Python args.
+
+
:param prefix: path prefix
+
:param file_type: type of file
+
:param properties: list of properties
+
"""
+
return cls(prefix, file_type, properties, None)
+
+
def __eq__(self, other: object) -> bool:
+
if not isinstance(other, PropertyGroup):
+
return False
+
+
return (
+
(self.get_prefix() == other.get_prefix())
+
and (self.get_file_type() == other.get_file_type())
+
and (len(self.get_properties()) == len(other.get_properties()))
+
and all(
+
p_left == p_right
+
for p_left, p_right in zip(
+
self.get_properties(),
+
other.get_properties(),
+
)
+
)
+
)
+
+
+# Return type of VertexInfo classmethods
+VertexInfoType = TypeVar("VertexInfoType", bound="VertexInfo")
+
+
+[docs]class VertexInfo:
+
"""VertexInfo is a class to store the vertex meta information."""
+
+
def __init__(
+
self,
+
label: Optional[str],
+
chunk_size: Optional[int],
+
prefix: Optional[str],
+
property_groups: Optional[Sequence[PropertyGroup]],
+
version: Optional[str],
+
jvm_obj: Optional[JavaObject],
+
) -> None:
+
"""One should not use this constructor directly, please use `from_scala` or `from_python`."""
+
_check_session()
+
if jvm_obj is not None:
+
self._jvm_vertex_info_obj = jvm_obj
+
else:
+
vertex_info = GraphArSession.graphar.VertexInfo()
+
vertex_info.setLabel(label)
+
vertex_info.setChunk_size(chunk_size)
+
vertex_info.setPrefix(prefix)
+
vertex_info.setProperty_groups(
+
[py_property_group.to_scala() for py_property_group in property_groups],
+
)
+
vertex_info.setVersion(version)
+
self._jvm_vertex_info_obj = vertex_info
+
+
[docs] def get_label(self) -> str:
+
"""Get label from the corresponding JVM object.
+
+
:returns: label
+
"""
+
return self._jvm_vertex_info_obj.getLabel()
+
+
[docs] def set_label(self, label: str) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param label: new label
+
"""
+
self._jvm_vertex_info_obj.setLabel(label)
+
+
[docs] def get_chunk_size(self) -> int:
+
"""Get chunk size from the corresponding JVM object.
+
+
:returns: chunk size
+
"""
+
return self._jvm_vertex_info_obj.getChunk_size()
+
+
[docs] def set_chunk_size(self, chunk_size: int) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param chunk_size: new chunk size
+
"""
+
self._jvm_vertex_info_obj.setChunk_size(chunk_size)
+
+
[docs] def get_prefix(self) -> str:
+
"""Get prefix from the corresponding JVM object.
+
+
:returns: prefix
+
"""
+
return self._jvm_vertex_info_obj.getPrefix()
+
+
[docs] def set_prefix(self, prefix: str) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param prefix: the new pefix.
+
"""
+
self._jvm_vertex_info_obj.setPrefix(prefix)
+
+
[docs] def get_property_groups(self) -> Sequence[PropertyGroup]:
+
"""Get property groups from the corresponding JVM object.
+
+
:returns: property groups
+
"""
+
return [
+
PropertyGroup.from_scala(jvm_property_group)
+
for jvm_property_group in self._jvm_vertex_info_obj.getProperty_groups()
+
]
+
+
[docs] def set_property_groups(self, property_groups: Sequence[PropertyGroup]) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param property_groups: new property groups
+
"""
+
self._jvm_vertex_info_obj.setProperty_groups(
+
[py_property_group.to_scala() for py_property_group in property_groups],
+
)
+
+
[docs] def get_version(self) -> str:
+
"""Get version from the corresponding JVM object.
+
+
:returns: version
+
"""
+
return self._jvm_vertex_info_obj.getVersion()
+
+
[docs] def set_version(self, version: str) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param version: the new version.
+
"""
+
self._jvm_vertex_info_obj.setVersion(version)
+
+
[docs] def contain_property_group(self, property_group: PropertyGroup) -> bool:
+
"""Check if the vertex info contains the property group.
+
+
:param property_group: the property group to check.
+
:returns: true if the vertex info contains the property group, otherwise false.
+
"""
+
return self._jvm_vertex_info_obj.containPropertyGroup(property_group.to_scala())
+
+
[docs] def contain_property(self, property_name: str) -> bool:
+
"""Check if the vertex info contains certain property.
+
+
:param property_name: name of the property.
+
:returns: true if the vertex info contains the property, otherwise false.
+
"""
+
return self._jvm_vertex_info_obj.containProperty(property_name)
+
+
[docs] def get_property_group(self, property_name: str) -> PropertyGroup:
+
"""Get the property group that contains property.
+
+
WARNING! Exceptions from the JVM are not checked inside, it is just a proxy-method!
+
+
:param property_name: name of the property.
+
:returns: property group that contains the property, otherwise raise IllegalArgumentException error.
+
"""
+
return PropertyGroup.from_scala(
+
self._jvm_vertex_info_obj.getPropertyGroup(property_name),
+
)
+
+
[docs] def get_property_type(self, property_name: str) -> GarType:
+
"""Get the data type of property.
+
+
WARNING! Exceptions from the JVM are not checked inside, it is just a proxy-method!
+
+
:param property_name: name of the property.
+
:returns: the data type in gar of the property. If the vertex info does not contains the property, raise IllegalArgumentException error.
+
"""
+
return GarType.from_scala(
+
self._jvm_vertex_info_obj.getPropertyType(property_name),
+
)
+
+
[docs] def is_primary_key(self, property_name: str) -> bool:
+
"""Check if the property is primary key.
+
+
:param property_name: name of the property to check.
+
:returns: true if the property if the primary key of vertex info, otherwise return false.
+
"""
+
return self._jvm_vertex_info_obj.isPrimaryKey(property_name)
+
+
[docs] def get_primary_key(self) -> str:
+
"""Get primary key of vertex info.
+
+
:returns: name of the primary key.
+
"""
+
return self._jvm_vertex_info_obj.getPrimaryKey()
+
+
[docs] def is_nullable_key(self, property_name: str) -> bool:
+
"""Check if the property is nullable key.
+
+
:param property_name: name of the property to check.
+
:returns: true if the property if a nullable key of vertex info, otherwise return false
+
"""
+
return self._jvm_vertex_info_obj.isNullableKey(property_name)
+
+
[docs] def is_validated(self) -> bool:
+
"""Check if the vertex info is validated.
+
+
:returns: true if the vertex info is validated, otherwise return false.
+
"""
+
return self._jvm_vertex_info_obj.isValidated()
+
+
[docs] def get_vertices_num_file_path(self) -> str:
+
"""Get the vertex num file path of vertex info.
+
+
:returns: vertex num file path of vertex info.
+
"""
+
return self._jvm_vertex_info_obj.getVerticesNumFilePath()
+
+
[docs] def get_file_path(self, property_group: PropertyGroup, chunk_index: int) -> str:
+
"""Get the chunk file path of property group of vertex chunk.
+
+
:param property_group: the property group.
+
:param chunk_index: the index of vertex chunk
+
:returns: chunk file path.
+
+
"""
+
return self._jvm_vertex_info_obj.getFilePath(
+
property_group.to_scala(),
+
chunk_index,
+
)
+
+
[docs] def get_path_prefix(self, property_group: PropertyGroup) -> str:
+
"""Get the path prefix for the specified property group.
+
+
:param property_group: the property group.
+
:returns: the path prefix of the property group chunk files.
+
"""
+
return self._jvm_vertex_info_obj.getPathPrefix(property_group.to_scala())
+
+
[docs] def dump(self) -> str:
+
"""Dump to Yaml string.
+
+
:returns: yaml string
+
"""
+
return self._jvm_vertex_info_obj.dump()
+
+
[docs] @staticmethod
+
def load_vertex_info(vertex_info_path: str) -> "VertexInfo":
+
"""Load a yaml file from path and construct a VertexInfo from it.
+
+
:param vertexInfoPath: yaml file path
+
:returns: VertexInfo object
+
"""
+
return VertexInfo.from_scala(
+
GraphArSession.graphar.VertexInfo.loadVertexInfo(
+
vertex_info_path,
+
GraphArSession.jss,
+
),
+
)
+
+
[docs] def to_scala(self) -> JavaObject:
+
"""Transform object to JVM representation.
+
+
:returns: JavaObject
+
"""
+
return self._jvm_vertex_info_obj
+
+
[docs] @classmethod
+
def from_scala(cls: type[VertexInfoType], jvm_obj: JavaObject) -> VertexInfoType:
+
"""Create an instance of the Class from the corresponding JVM object.
+
+
:param jvm_obj: scala object in JVM.
+
:returns: instance of Python Class.
+
"""
+
return VertexInfo(
+
None,
+
None,
+
None,
+
None,
+
None,
+
jvm_obj,
+
)
+
+
[docs] @classmethod
+
def from_python(
+
cls: type[VertexInfoType],
+
label: str,
+
chunk_size: int,
+
prefix: str,
+
property_groups: Sequence[PropertyGroup],
+
version: str,
+
) -> VertexInfoType:
+
"""Create an instance of the class based on python args.
+
+
:param label: label of the vertex
+
:chunk_size: chunk size
+
:prefix: vertex prefix
+
:property_groups: list of property groups
+
:version: version of GAR
+
"""
+
return VertexInfo(label, chunk_size, prefix, property_groups, version, None)
+
+
+# Return type of AdjList classmethods
+AdjListClassType = TypeVar("AdjListClassType", bound="AdjList")
+
+
+[docs]class AdjList:
+
"""AdjList is a class to store the adj list information of edge."""
+
+
def __init__(
+
self,
+
ordered: Optional[bool],
+
aligned_by: Optional[str],
+
prefix: Optional[str],
+
file_type: Optional[FileType],
+
jvm_obj: Optional[JavaObject],
+
) -> None:
+
"""One should not use this constructor directly, please use `from_scala` or `from_python`."""
+
_check_session()
+
if jvm_obj is not None:
+
self._jvm_adj_list_obj = jvm_obj
+
else:
+
jvm_adj_list = GraphArSession.graphar.AdjList()
+
jvm_adj_list.setOrdered(ordered)
+
jvm_adj_list.setAligned_by(aligned_by)
+
jvm_adj_list.setPrefix(prefix)
+
jvm_adj_list.setFile_type(file_type.value)
+
self._jvm_adj_list_obj = jvm_adj_list
+
+
[docs] def get_ordered(self) -> bool:
+
"""Get ordered flag from the corresponding JVM object.
+
+
:returns: ordered
+
"""
+
return self._jvm_adj_list_obj.getOrdered()
+
+
[docs] def set_ordered(self, ordered: bool) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param ordered: new ordered flag
+
"""
+
self._jvm_adj_list_obj.setOrdered(ordered)
+
+
[docs] def get_aligned_by(self) -> str:
+
"""Get aligned_by from the corresponding JVM object.
+
+
:returns: aligned by as a string ("src", "dst")
+
"""
+
return self._jvm_adj_list_obj.getAligned_by()
+
+
[docs] def set_aligned_by(self, aligned_by: str) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param aligned_by: the new aligned_by (recommended to use "src" or "dst")
+
+
"""
+
self._jvm_adj_list_obj.setAligned_by(aligned_by)
+
+
[docs] def get_prefix(self) -> str:
+
"""Get prefix from the corresponding JVM object.
+
+
:returns: prefix
+
"""
+
return self._jvm_adj_list_obj.getPrefix()
+
+
[docs] def set_prefix(self, prefix: str) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param prefix: the new prefix
+
+
"""
+
self._jvm_adj_list_obj.setPrefix(prefix)
+
+
[docs] def get_file_type(self) -> FileType:
+
"""Get FileType (as Enum) from the corresponding JVM object.
+
+
:returns: file type
+
"""
+
return FileType(self._jvm_adj_list_obj.getFile_type())
+
+
[docs] def set_file_type(self, file_type: FileType) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param file_type: the new file type
+
"""
+
self._jvm_adj_list_obj.setFile_type(file_type.value)
+
+
[docs] def get_adj_list_type(self) -> AdjListType:
+
"""Get adj list type.
+
+
:returns: adj list type.
+
"""
+
return AdjListType(self._jvm_adj_list_obj.getAdjList_type())
+
+
[docs] def to_scala(self) -> JavaObject:
+
"""Transform object to JVM representation.
+
+
:returns: JavaObject
+
"""
+
return self._jvm_adj_list_obj
+
+
[docs] @classmethod
+
def from_scala(
+
cls: type[AdjListClassType],
+
jvm_obj: JavaObject,
+
) -> AdjListClassType:
+
"""Create an instance of the Class from the corresponding JVM object.
+
+
:param jvm_obj: scala object in JVM.
+
:returns: instance of Python Class.
+
"""
+
return AdjList(None, None, None, None, jvm_obj)
+
+
[docs] @classmethod
+
def from_python(
+
cls: type[AdjListClassType],
+
ordered: bool,
+
aligned_by: str,
+
prefix: str,
+
file_type: FileType,
+
) -> AdjListClassType:
+
"""Create an instance of the class from python arguments.
+
+
:param ordered: ordered flag
+
:param aligned_by: recommended values are "src" or "dst"
+
:param prefix: path prefix
+
:param file_type: file type
+
"""
+
if not prefix.endswith(os.sep):
+
prefix += os.sep
+
return AdjList(ordered, aligned_by, prefix, file_type, None)
+
+
def __eq__(self, other: object) -> bool:
+
if not isinstance(other, AdjList):
+
return False
+
+
return (
+
(self.get_ordered() == other.get_ordered())
+
and (self.get_aligned_by() == other.get_aligned_by())
+
and (self.get_prefix() == other.get_prefix())
+
and (self.get_file_type() == other.get_file_type())
+
)
+
+
+# Return type of EdgeInfo classmethods
+EdgeInfoType = TypeVar("EdgeInfoType", bound="EdgeInfo")
+
+
+[docs]class EdgeInfo:
+
"""Edge info is a class to store the edge meta information."""
+
+
def __init__(
+
self,
+
src_label: Optional[str],
+
edge_label: Optional[str],
+
dst_label: Optional[str],
+
chunk_size: Optional[int],
+
src_chunk_size: Optional[int],
+
dst_chunk_size: Optional[int],
+
directed: Optional[bool],
+
prefix: Optional[str],
+
adj_lists: Sequence[AdjList],
+
property_groups: Optional[Sequence[PropertyGroup]],
+
version: Optional[str],
+
jvm_edge_info_obj: JavaObject,
+
) -> None:
+
"""One should not use this constructor directly, please use `from_scala` or `from_python`."""
+
_check_session()
+
if jvm_edge_info_obj is not None:
+
self._jvm_edge_info_obj = jvm_edge_info_obj
+
else:
+
edge_info = GraphArSession.graphar.EdgeInfo()
+
edge_info.setSrc_label(src_label)
+
edge_info.setEdge_label(edge_label)
+
edge_info.setDst_label(dst_label)
+
edge_info.setChunk_size(chunk_size)
+
edge_info.setSrc_chunk_size(src_chunk_size)
+
edge_info.setDst_chunk_size(dst_chunk_size)
+
edge_info.setDirected(directed)
+
edge_info.setPrefix(prefix)
+
edge_info.setAdj_lists(
+
[py_adj_list.to_scala() for py_adj_list in adj_lists],
+
)
+
edge_info.setProperty_groups(
+
[py_property_group.to_scala() for py_property_group in property_groups],
+
)
+
edge_info.setVersion(version)
+
self._jvm_edge_info_obj = edge_info
+
+
[docs] def get_src_label(self) -> str:
+
"""Get src label from the corresponding JVM object.
+
+
:returns: src label
+
"""
+
return self._jvm_edge_info_obj.getSrc_label()
+
+
[docs] def set_src_label(self, src_label: str) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param src_label: the new src label
+
"""
+
self._jvm_edge_info_obj.setSrc_label(src_label)
+
+
[docs] def get_edge_label(self) -> str:
+
"""Get edge label from the corresponding JVM object.
+
+
:returns: edge label
+
"""
+
return self._jvm_edge_info_obj.getEdge_label()
+
+
[docs] def set_edge_label(self, edge_label: str) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param edge_label: the new edge label
+
"""
+
self._jvm_edge_info_obj.setEdge_label(edge_label)
+
+
[docs] def get_dst_label(self) -> str:
+
"""Get dst label from the corresponding JVM object.
+
+
:returns: dst label
+
"""
+
return self._jvm_edge_info_obj.getDst_label()
+
+
[docs] def set_dst_label(self, dst_label: str) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param dst_label: the new dst label
+
"""
+
self._jvm_edge_info_obj.setDst_label(dst_label)
+
+
[docs] def get_chunk_size(self) -> int:
+
"""Get chunk size from the corresponding JVM object.
+
+
:returns: chunk size
+
"""
+
return self._jvm_edge_info_obj.getChunk_size()
+
+
[docs] def set_chunk_size(self, chunk_size: int) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param chunk_size: the new chunk size
+
"""
+
self._jvm_edge_info_obj.setChunk_size(chunk_size)
+
+
[docs] def get_src_chunk_size(self) -> int:
+
"""Get source chunk size from the corresponding JVM object.
+
+
:returns: source chunk size
+
"""
+
return self._jvm_edge_info_obj.getSrc_chunk_size()
+
+
[docs] def set_src_chunk_size(self, src_chunk_size: int) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param src_chunk_size: the new source chunk size.
+
"""
+
self._jvm_edge_info_obj.setSrc_chunk_size(src_chunk_size)
+
+
[docs] def get_dst_chunk_size(self) -> int:
+
"""Get dest chunk size from the corresponding JVM object.
+
+
:returns: destination chunk size
+
"""
+
return self._jvm_edge_info_obj.getDst_chunk_size()
+
+
[docs] def set_dst_chunk_size(self, dst_chunk_size: int) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param dst_chunk_size: the new destination chunk size.
+
"""
+
self._jvm_edge_info_obj.setDst_chunk_size(dst_chunk_size)
+
+
[docs] def get_directed(self) -> bool:
+
"""Get directed flag from the corresponding JVM object.
+
+
:returns: directed flag
+
"""
+
return self._jvm_edge_info_obj.getDirected()
+
+
[docs] def set_directed(self, directed: bool) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param directed: the new directed flag
+
"""
+
self._jvm_edge_info_obj.setDirected(directed)
+
+
[docs] def get_prefix(self) -> str:
+
"""Get prefix from the corresponding JVM object.
+
+
:returns: prefix
+
"""
+
return self._jvm_edge_info_obj.getPrefix()
+
+
[docs] def set_prefix(self, prefix: str) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param prefix: the new prefix
+
"""
+
self._jvm_edge_info_obj.setPrefix(prefix)
+
+
[docs] def get_adj_lists(self) -> Sequence[AdjList]:
+
"""Get adj lists from the corresponding JVM object.
+
+
:returns: sequence of AdjList
+
"""
+
return [
+
AdjList.from_scala(jvm_adj_list)
+
for jvm_adj_list in self._jvm_edge_info_obj.getAdj_lists()
+
]
+
+
[docs] def set_adj_lists(self, adj_lists: Sequence[AdjList]) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param adj_lists: the new adj lists, sequence of AdjList
+
"""
+
self._jvm_edge_info_obj.setAdj_lists(
+
[py_adj_list.to_scala() for py_adj_list in adj_lists],
+
)
+
+
[docs] def get_property_groups(self) -> Sequence[PropertyGroup]:
+
"""Get the property groups of adj list type.
+
+
WARNING! Exceptions from the JVM are not checked inside, it is just a proxy-method!
+
+
:returns: property groups of edge info.
+
"""
+
return [
+
PropertyGroup.from_scala(jvm_property_group)
+
for jvm_property_group in self._jvm_edge_info_obj.getProperty_groups()
+
]
+
+
[docs] def set_property_groups(self, property_groups: Sequence[PropertyGroup]) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param property_groups: the new property groups, sequence of PropertyGroup
+
"""
+
self._jvm_edge_info_obj.setProperty_groups(
+
[py_property_group.to_scala() for py_property_group in property_groups],
+
)
+
+
[docs] def get_version(self) -> str:
+
"""Get GAR version from the corresponding JVM object.
+
+
:returns: GAR version
+
"""
+
return self._jvm_edge_info_obj.getVersion()
+
+
[docs] def set_version(self, version: str) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param version: the new GAR version
+
"""
+
self._jvm_edge_info_obj.setVersion(version)
+
+
[docs] def to_scala(self) -> JavaObject:
+
"""Transform object to JVM representation.
+
+
:returns: JavaObject
+
"""
+
return self._jvm_edge_info_obj
+
+
[docs] @classmethod
+
def from_scala(cls: type[EdgeInfoType], jvm_obj: JavaObject) -> EdgeInfoType:
+
"""Create an instance of the Class from the corresponding JVM object.
+
+
:param jvm_obj: scala object in JVM.
+
:returns: instance of Python Class.
+
"""
+
return EdgeInfo(
+
None,
+
None,
+
None,
+
None,
+
None,
+
None,
+
None,
+
None,
+
None,
+
None,
+
None,
+
jvm_obj,
+
)
+
+
[docs] @classmethod
+
def from_python(
+
cls: type[EdgeInfoType],
+
src_label: str,
+
edge_label: str,
+
dst_label: str,
+
chunk_size: int,
+
src_chunk_size: int,
+
dst_chunk_size: int,
+
directed: bool,
+
prefix: str,
+
adj_lists: Sequence[AdjList],
+
property_groups: Sequence[PropertyGroup],
+
version: str,
+
) -> EdgeInfoType:
+
"""Create an instance of the class from python arguments.
+
+
:param src_label: source vertex label
+
:param edge_label: edges label
+
:param dst_label: destination vertex label
+
:param chunk_size: chunk size
+
:param src_chunk_size: source chunk size
+
:param dst_chunk_size: destination chunk size
+
:param directed: directed graph flag
+
:param prefix: path prefix
+
:param adj_lists: sequence of AdjList objects
+
:property_groups: sequence of of PropertyGroup objects
+
:param version: version of GAR format
+
"""
+
if not prefix.endswith(os.sep):
+
prefix += os.sep
+
+
return EdgeInfo(
+
src_label,
+
edge_label,
+
dst_label,
+
chunk_size,
+
src_chunk_size,
+
dst_chunk_size,
+
directed,
+
prefix,
+
adj_lists,
+
property_groups,
+
version,
+
None,
+
)
+
+
[docs] def contain_adj_list(self, adj_list_type: AdjListType) -> bool:
+
"""Check if the edge info supports the adj list type.
+
+
:param adj_list_type: adjList type in gar to check.
+
:returns: true if edge info supports the adj list type, otherwise return false.
+
"""
+
return self._jvm_edge_info_obj.containAdjList(adj_list_type.to_scala())
+
+
[docs] def get_adj_list_prefix(self, adj_list_type: AdjListType) -> str:
+
"""Get path prefix of adj list type.
+
+
WARNING! Exceptions from the JVM are not checked inside, it is just a proxy-method!
+
+
:param adj_list_type: The input adj list type in gar.
+
:returns: path prefix of the adj list type, if edge info not support the adj list type, raise an IllegalArgumentException error.
+
"""
+
return self._jvm_edge_info_obj.getAdjListPrefix(adj_list_type.to_scala())
+
+
[docs] def get_adj_list_file_type(self, adj_list_type: AdjListType) -> FileType:
+
"""Get the adj list topology chunk file type of adj list type.
+
+
WARNING! Exceptions from the JVM are not checked inside, it is just a proxy-method!
+
+
:param adj_list_type: the input adj list type.
+
:returns: file format type in gar of the adj list type, if edge info not support the adj list type,
+
raise an IllegalArgumentException error.
+
"""
+
return FileType.from_scala(
+
self._jvm_edge_info_obj.getAdjListFileType(adj_list_type.to_scala()),
+
)
+
+
[docs] def contain_property_group(
+
self,
+
property_group: PropertyGroup,
+
) -> bool:
+
"""Check if the edge info contains the property group.
+
+
:param property_group: the property group to check.
+
:returns: true if the edge info contains the property group in certain adj list
+
structure.
+
"""
+
return self._jvm_edge_info_obj.containPropertyGroup(
+
property_group.to_scala(),
+
)
+
+
[docs] def contain_property(self, property_name: str) -> bool:
+
"""Check if the edge info contains the property.
+
+
:param property_name: name of the property.
+
:returns: true if edge info contains the property, otherwise false.
+
"""
+
return self._jvm_edge_info_obj.containProperty(property_name)
+
+
[docs] def get_property_group(
+
self,
+
property_name: str,
+
) -> PropertyGroup:
+
"""Get property group that contains property with adj list type.
+
+
WARNING! Exceptions from the JVM are not checked inside, it is just a proxy-method!
+
+
:param property_name: name of the property.
+
:returns: property group that contains the property. If edge info not find the property group that contains the property,
+
raise error.
+
"""
+
return PropertyGroup.from_scala(
+
self._jvm_edge_info_obj.getPropertyGroup(property_name),
+
)
+
+
[docs] def get_property_type(self, property_name: str) -> GarType:
+
"""Get the data type of property.
+
+
WARNING! Exceptions from the JVM are not checked inside, it is just a proxy-method!
+
+
:param property_name: name of the property.
+
:returns: data type in gar of the property. If edge info not contains the property, raise an IllegalArgumentException error.
+
"""
+
return GarType.from_scala(
+
self._jvm_edge_info_obj.getPropertyType(property_name),
+
)
+
+
[docs] def is_primary_key(self, property_name: str) -> bool:
+
"""Check the property is primary key of edge info.
+
+
WARNING! Exceptions from the JVM are not checked inside, it is just a proxy-method!
+
+
:param property_name: name of the property.
+
:returns: true if the property is the primary key of edge info, false if not. If
+
edge info not contains the property, raise an IllegalArgumentException error.
+
"""
+
return self._jvm_edge_info_obj.isPrimaryKey(property_name)
+
+
[docs] def is_nullable_key(self, property_name: str) -> bool:
+
"""Check the property is nullable key of edge info.
+
+
:param property_name: name of the property.
+
:returns: true if the property is the nullable key of edge info, false if not. If
+
edge info not contains the property, raise an IllegalArgumentException error.
+
"""
+
return self._jvm_edge_info_obj.isNullableKey(property_name)
+
+
[docs] def get_primary_key(self) -> str:
+
"""Get Primary key of edge info.
+
+
:returns: primary key of edge info.
+
"""
+
return self._jvm_edge_info_obj.getPrimaryKey()
+
+
[docs] def is_validated(self) -> bool:
+
"""Check if the edge info is validated.
+
+
:returns: true if edge info is validated or false if not.
+
"""
+
return self._jvm_edge_info_obj.isValidated()
+
+
[docs] def get_vertices_num_file_path(self, adj_list_type: AdjListType) -> str:
+
"""Get the vertex num file path.
+
+
WARNING! Exceptions from the JVM are not checked inside, it is just a proxy-method!
+
+
:param adj_list_type: type of adj list structure.
+
:returns: the vertex num file path. If edge info not support the adj list type,
+
raise an IllegalArgumentException error.
+
"""
+
return self._jvm_edge_info_obj.getVerticesNumFilePath(adj_list_type.to_scala())
+
+
[docs] def get_edges_num_path_prefix(self, adj_list_type: AdjListType) -> str:
+
"""Get the path prefix of the edge num file path.
+
+
WARNING! Exceptions from the JVM are not checked inside, it is just a proxy-method!
+
+
:param adj_list_type: type of adj list structure.
+
:returns: the edge num file path. If edge info not support the adj list type, raise
+
an IllegalArgumentException error.
+
"""
+
return self._jvm_edge_info_obj.getEdgesNumPathPrefix(adj_list_type.to_scala())
+
+
[docs] def get_edges_num_file_path(
+
self,
+
chunk_index: int,
+
adj_list_type: AdjListType,
+
) -> str:
+
"""Get the edge num file path of the vertex chunk.
+
+
WARNING! Exceptions from the JVM are not checked inside, it is just a proxy-method!
+
+
:param chunk_index: index of vertex chunk.
+
:param adj_list_type: type of adj list structure.
+
:returns: the edge num file path. If edge info not support the adj list type, raise
+
an IllegalArgumentException error.
+
"""
+
return self._jvm_edge_info_obj.getEdgesNumFilePath(
+
chunk_index,
+
adj_list_type.to_scala(),
+
)
+
+
[docs] def get_adj_list_offset_file_path(
+
self,
+
chunk_index: int,
+
adj_list_type: AdjListType,
+
) -> str:
+
"""Get the adj list offset chunk file path of vertex chunk the offset chunks is aligned with the vertex chunks.
+
+
WARNING! Exceptions from the JVM are not checked inside, it is just a proxy-method!
+
+
:param chunk_index: index of vertex chunk.
+
:param adj_list_type: type of adj list structure.
+
:returns: the offset chunk file path. If edge info not support the adj list type, raise an IllegalArgumentException error.
+
+
"""
+
return self._jvm_edge_info_obj.getAdjListOffsetFilePath(
+
chunk_index,
+
adj_list_type.to_scala(),
+
)
+
+
[docs] def get_offset_path_prefix(self, adj_list_type: AdjListType) -> str:
+
"""Get the path prefix of the adjacency list offset for the given adjacency list type.
+
+
WARNING! Exceptions from the JVM are not checked inside, it is just a proxy-method!
+
+
:param adj_list_type: type of adj list structure.
+
:returns: the path prefix of the offset. If edge info not support the adj list type, raise an IllegalArgumentException error.
+
+
"""
+
return self._jvm_edge_info_obj.getOffsetPathPrefix(adj_list_type.to_scala())
+
+
[docs] def get_adj_list_file_path(
+
self,
+
vertex_chunk_index: int,
+
chunk_index: int,
+
adj_list_type: AdjListType,
+
) -> str:
+
"""Get the file path of adj list topology chunk.
+
+
:param vertex_chunk_index: index of vertex chunk.
+
:param chunk_index: index of edge chunk.
+
:param adj_list_type: type of adj list structure.
+
:returns: adj list chunk file path.
+
"""
+
return self._jvm_edge_info_obj.getAdjListFilePath(
+
vertex_chunk_index,
+
chunk_index,
+
adj_list_type.to_scala(),
+
)
+
+
[docs] def get_adj_list_path_prefix(
+
self,
+
vertex_chunk_index: Optional[int],
+
adj_list_type: AdjListType,
+
) -> str:
+
"""Get the path prefix of adj list topology chunk of certain vertex chunk.
+
+
:param vertex_chunk_index: index of vertex chunk (optional).
+
:param adj_list_type: type of adj list structure.
+
:returns: path prefix of the edge chunk of vertices of given vertex chunk.
+
"""
+
if vertex_chunk_index is None:
+
return self._jvm_edge_info_obj.getAdjListPathPrefix(
+
adj_list_type.to_scala(),
+
)
+
+
return self._jvm_edge_info_obj.getAdjListPathPrefix(
+
vertex_chunk_index,
+
adj_list_type.to_scala(),
+
)
+
+
[docs] def get_property_file_path(
+
self,
+
property_group: PropertyGroup,
+
adj_list_type: AdjListType,
+
vertex_chunk_index: int,
+
chunk_index: int,
+
) -> str:
+
"""Get the chunk file path of adj list property group. the property group chunks is aligned with the adj list topology chunks.
+
+
WARNING! Exceptions from the JVM are not checked inside, it is just a proxy-method!
+
+
:param property_group: property group
+
:param adj_list_type: type of adj list structure.
+
:param vertex_chunk_index: index of vertex chunk.
+
:param chunk_index: index of edge chunk.
+
:returns: property group chunk file path. If edge info not contains the property group, raise an IllegalArgumentException error.
+
"""
+
return self._jvm_edge_info_obj.getPropertyFilePath(
+
property_group.to_scala(),
+
adj_list_type.to_scala(),
+
vertex_chunk_index,
+
chunk_index,
+
)
+
+
[docs] def get_property_group_path_prefix(
+
self,
+
property_group: PropertyGroup,
+
adj_list_type: AdjListType,
+
vertex_chunk_index: Optional[int] = None,
+
) -> str:
+
"""Get path prefix of adj list property group of certain vertex chunk.
+
+
WARNING! Exceptions from the JVM are not checked inside, it is just a proxy-method!
+
+
:param property_group: property group.
+
:param adj_list_type: type of adj list structure.
+
:param vertex_chunk_index: index of vertex chunk (optional, default is None).
+
:returns: path prefix of property group chunks of of vertices of given vertex
+
chunk. If edge info not contains the property group, raise an IllegalArgumentException error.
+
"""
+
if vertex_chunk_index is not None:
+
return self._jvm_edge_info_obj.getPropertyGroupPathPrefix(
+
property_group.to_scala(),
+
adj_list_type.to_scala(),
+
vertex_chunk_index,
+
)
+
+
return self._jvm_edge_info_obj.getPropertyGroupPathPrefix(
+
property_group.to_scala(),
+
adj_list_type.to_scala(),
+
)
+
+
[docs] def get_concat_key(self) -> str:
+
"""Get concat key.
+
+
:returns: concat key
+
"""
+
return self._jvm_edge_info_obj.getConcatKey()
+
+
[docs] def dump(self) -> str:
+
"""Dump to Yaml string.
+
+
:returns: yaml-string representation.
+
"""
+
return self._jvm_edge_info_obj.dump()
+
+
[docs] @staticmethod
+
def load_edge_info(edge_info_path: str) -> "EdgeInfo":
+
"""Load a yaml file from path and construct a EdgeInfo from it.
+
+
:param edge_info_path: path of edge info YAML file.
+
:returns: EdgeInfo object.
+
"""
+
return EdgeInfo.from_scala(
+
GraphArSession.graphar.EdgeInfo.loadEdgeInfo(
+
edge_info_path,
+
GraphArSession.jss,
+
),
+
)
+
+
+[docs]class GraphInfo:
+
"""GraphInfo is a class to store the graph meta information."""
+
+
def __init__(
+
self,
+
name: Optional[str],
+
prefix: Optional[str],
+
vertices: Optional[list[str]],
+
edges: Optional[list[str]],
+
version: Optional[str],
+
jvm_grpah_info_obj: Optional[JavaObject],
+
) -> None:
+
"""One should not use this constructor directly, please use `from_scala` or `from_python`."""
+
_check_session()
+
if jvm_grpah_info_obj is not None:
+
self._jvm_graph_info_obj = jvm_grpah_info_obj
+
else:
+
graph_info = GraphArSession.graphar.GraphInfo()
+
graph_info.setName(name)
+
graph_info.setPrefix(prefix)
+
graph_info.setVertices(vertices)
+
graph_info.setEdges(edges)
+
graph_info.setVersion(version)
+
self._jvm_graph_info_obj = graph_info
+
+
[docs] def get_name(self) -> str:
+
"""Get name from the corresponding JVM object.
+
+
:returns: name
+
"""
+
return self._jvm_graph_info_obj.getName()
+
+
[docs] def set_name(self, name: str) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param name: new name
+
"""
+
self._jvm_graph_info_obj.setName(name)
+
+
[docs] def get_prefix(self) -> str:
+
"""Get prefix from corresponding JVM object.
+
+
:returns: prefix
+
"""
+
return self._jvm_graph_info_obj.getPrefix()
+
+
[docs] def set_prefix(self, prefix: str) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param prefix: new prefix
+
"""
+
self._jvm_graph_info_obj.setPrefix(prefix)
+
+
[docs] def get_vertices(self) -> JavaList:
+
"""Get list of vertices from the corresponding JVM object.
+
+
:returns: vertices
+
"""
+
return self._jvm_graph_info_obj.getVertices()
+
+
[docs] def set_vertices(self, vertices: Union[list[str], JavaList]) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param vertices: new list of vertices
+
"""
+
self._jvm_graph_info_obj.setVertices(vertices)
+
+
[docs] def get_edges(self) -> JavaList:
+
"""Get list of edges from the corresponding JVM object.
+
+
:returns: edges
+
"""
+
return self._jvm_graph_info_obj.getEdges()
+
+
[docs] def set_edges(self, edges: Union[list[str], JavaList]) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param edges: new list of edges.
+
"""
+
self._jvm_graph_info_obj.setEdges(edges)
+
+
[docs] def get_version(self) -> str:
+
"""Get GAR version from the corresponding JVM object.
+
+
:returns: version
+
"""
+
return self._jvm_graph_info_obj.getVersion()
+
+
[docs] def set_version(self, version: str) -> None:
+
"""Mutate the corresponding JVM object.
+
+
:param version: new version of GAR
+
"""
+
self._jvm_graph_info_obj.setVersion(version)
+
+
[docs] def to_scala(self) -> JavaObject:
+
"""Transform object to JVM representation.
+
+
:returns: JavaObject
+
"""
+
return self._jvm_graph_info_obj
+
+
[docs] @staticmethod
+
def from_scala(jvm_obj: JavaObject) -> "GraphInfo":
+
"""Create an instance of the Class from the corresponding JVM object.
+
+
:param jvm_obj: scala object in JVM.
+
:returns: instance of Python Class.
+
"""
+
return GraphInfo(None, None, None, None, None, jvm_obj)
+
+
[docs] @staticmethod
+
def from_python(
+
name: str,
+
prefix: str,
+
vertices: Sequence[str],
+
edges: Sequence[str],
+
version: str,
+
) -> "GraphInfo":
+
"""Create an instance of the class from python arguments.
+
+
:param name: name of the graph
+
:param prefix: path prefix
+
:param vertices: list of vertices
+
:param edges: list of edges
+
:param version: version of GAR format
+
"""
+
if not prefix.endswith(os.sep):
+
prefix += os.sep
+
return GraphInfo(name, prefix, vertices, edges, version, None)
+
+
[docs] def add_vertex_info(self, vertex_info: VertexInfo) -> None:
+
"""Add VertexInfo to GraphInfo.
+
+
:param vertex_info: VertexInfo to add
+
"""
+
self._jvm_graph_info_obj.addVertexInfo(vertex_info.to_scala())
+
+
[docs] def add_edge_info(self, edge_info: EdgeInfo) -> None:
+
"""Add EdgeInfo to GraphInfo.
+
+
:param edge_info: EdgeInfo to add
+
"""
+
self._jvm_graph_info_obj.addEdgeInfo(edge_info.to_scala())
+
+
[docs] def get_vertex_info(self, label: str) -> VertexInfo:
+
"""Get vertex info from the corresponding JVM object.
+
+
:param label: label of vertex
+
"""
+
return VertexInfo.from_scala(self._jvm_graph_info_obj.getVertexInfo(label))
+
+
[docs] def get_edge_info(
+
self,
+
src_label: str,
+
edge_label: str,
+
dst_label: str,
+
) -> EdgeInfo:
+
"""Get edge info from the corresponding JVM object.
+
+
:param src_label: source label
+
:param edge_label: edge label
+
:param dst_label: destination label
+
"""
+
return EdgeInfo.from_scala(
+
self._jvm_graph_info_obj.getEdgeInfo(src_label, edge_label, dst_label),
+
)
+
+
[docs] def get_vertex_infos(self) -> dict[str, VertexInfo]:
+
"""Get all vertex infos from the corresponding JVM object.
+
+
:returns: Mapping label -> VertexInfo
+
"""
+
scala_map = self._jvm_graph_info_obj.getVertexInfos()
+
keys_set_iter = scala_map.keySet().iterator()
+
res = {}
+
while keys_set_iter.hasNext():
+
k = keys_set_iter.next()
+
res[k] = VertexInfo.from_scala(scala_map.get(k))
+
+
return res
+
+
[docs] def get_edge_infos(self) -> dict[str, EdgeInfo]:
+
"""Get all edge infos from the corresponding JVM object.
+
+
:returns: Mapping {src_label}_{edge_label}_{dst_label} -> EdgeInfo
+
"""
+
scala_map = self._jvm_graph_info_obj.getEdgeInfos()
+
keys_set_iter = scala_map.keySet().iterator()
+
res = {}
+
while keys_set_iter.hasNext():
+
k = keys_set_iter.next()
+
res[k] = EdgeInfo.from_scala(scala_map.get(k))
+
+
return res
+
+
[docs] def dump(self) -> str:
+
"""Dump to Yaml string.
+
+
:returns: YAML-string representation of object.
+
"""
+
return self._jvm_graph_info_obj.dump()
+
+
[docs] @staticmethod
+
def load_graph_info(graph_info_path: str) -> "GraphInfo":
+
"""Load a yaml file from path and construct a GraphInfo from it.
+
+
:param graph_info_path: path of GraphInfo YAML file.
+
:returns: GraphInfo object.
+
"""
+
return GraphInfo.from_scala(
+
GraphArSession.graphar.GraphInfo.loadGraphInfo(
+
graph_info_path,
+
GraphArSession.jss,
+
),
+
)
+