graphar_pyspark.enums

  1# Licensed to the Apache Software Foundation (ASF) under one
  2# or more contributor license agreements.  See the NOTICE file
  3# distributed with this work for additional information
  4# regarding copyright ownership.  The ASF licenses this file
  5# to you under the Apache License, Version 2.0 (the
  6# "License"); you may not use this file except in compliance
  7# with the License.  You may obtain a copy of the License at
  8#
  9#   http://www.apache.org/licenses/LICENSE-2.0
 10#
 11# Unless required by applicable law or agreed to in writing,
 12# software distributed under the License is distributed on an
 13# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 14# KIND, either express or implied.  See the License for the
 15# specific language governing permissions and limitations
 16# under the License.
 17
 18"""Enumerations and constants."""
 19
 20from enum import Enum
 21
 22from py4j.java_gateway import JavaObject
 23
 24from graphar_pyspark import GraphArSession, _check_session
 25
 26
 27class GarType(Enum):
 28    """Main data type in gar enumeration."""
 29
 30    BOOL = "bool"
 31    INT32 = "int32"
 32    INT64 = "int64"
 33    FLOAT = "float"
 34    DOUBLE = "double"
 35    STRING = "string"
 36    LIST = "list"
 37
 38    @staticmethod
 39    def from_scala(jvm_obj: JavaObject) -> "GarType":
 40        """Create an instance of the Class from the corresponding JVM object.
 41
 42        :param jvm_obj: scala object in JVM.
 43        :returns: instance of Python Class.
 44        """
 45        _check_session()
 46        return GarType(GraphArSession.graphar.GarType.GarTypeToString(jvm_obj))
 47
 48    def to_scala(self) -> JavaObject:
 49        """Transform object to JVM representation.
 50
 51        :returns: JavaObject
 52        """
 53        _check_session()
 54        return GraphArSession.graphar.GarType.StringToGarType(self.value)
 55
 56
 57class FileType(Enum):
 58    """Type of  file format."""
 59
 60    CSV = "csv"
 61    JSON = "json"
 62    PARQUET = "parquet"
 63    ORC = "orc"
 64
 65    @staticmethod
 66    def from_scala(jvm_obj: JavaObject) -> "FileType":
 67        """Create an instance of the Class from the corresponding JVM object.
 68
 69        :param jvm_obj: scala object in JVM.
 70        :returns: instance of Python Class.
 71        """
 72        _check_session()
 73        return FileType(GraphArSession.graphar.FileType.FileTypeToString(jvm_obj))
 74
 75    def to_scala(self) -> JavaObject:
 76        """Transform object to JVM representation.
 77
 78        :returns: JavaObject
 79        """
 80        _check_session()
 81        return GraphArSession.graphar.FileType.StringToFileType(self.value)
 82
 83
 84class AdjListType(Enum):
 85    """Adj list type enumeration for adjacency list of graph."""
 86
 87    UNORDERED_BY_SOURCE = "unordered_by_source"
 88    UNORDERED_BY_DEST = "unordered_by_dest"
 89    ORDERED_BY_SOURCE = "ordered_by_source"
 90    ORDERED_BY_DEST = "ordered_by_dest"
 91
 92    @staticmethod
 93    def from_scala(jvm_obj: JavaObject) -> "AdjListType":
 94        """Create an instance of the Class from the corresponding JVM object.
 95
 96        :param jvm_obj: scala object in JVM.
 97        :returns: instance of Python Class.
 98        """
 99        _check_session()
100        return AdjListType(
101            GraphArSession.graphar.AdjListType.AdjListTypeToString(jvm_obj),
102        )
103
104    def to_scala(self) -> JavaObject:
105        """Transform object to JVM representation.
106
107        :returns: JavaObject
108        """
109        _check_session()
110        return GraphArSession.graphar.AdjListType.StringToAdjListType(self.value)