Packages

case class EdgePropertyGroup extends PropertyGroup with Product with Serializable

Represents a logical group of edges in a property graph with associated metadata and data.

EdgePropertyGroup encapsulates edge data stored in a DataFrame along with metadata describing how to interpret the data as graph edges. Each edge group has:

  • A unique name identifier
  • DataFrame containing the actual edge data
  • Source and destination vertex property groups
  • Direction flag indicating if edges are directed or undirected
  • Column names specifying source vertex, destination vertex and edge weight columns

The class validates that required columns exist in the provided DataFrame on creation. Required columns are:

  • Source vertex column
  • Destination vertex column
  • Weight column
Note

When edges from different groups are combined into a GraphFrame, their SRCs and DSTs are hashed with the group name to prevent collisions in the same way as ID of the corresponded vertex group is hashed.

Linear Supertypes
Serializable, Serializable, Product, Equals, PropertyGroup, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EdgePropertyGroup
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. PropertyGroup
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from EdgePropertyGroup to any2stringadd[EdgePropertyGroup] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EdgePropertyGroup, B)
    Implicit
    This member is added by an implicit conversion from EdgePropertyGroup to ArrowAssoc[EdgePropertyGroup] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. val data: DataFrame
    Definition Classes
    EdgePropertyGroup → PropertyGroup
  9. val dstColumnName: String
  10. val dstPropertyGroup: VertexPropertyGroup
  11. def ensuring(cond: (EdgePropertyGroup) ⇒ Boolean, msg: ⇒ Any): EdgePropertyGroup
    Implicit
    This member is added by an implicit conversion from EdgePropertyGroup to Ensuring[EdgePropertyGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (EdgePropertyGroup) ⇒ Boolean): EdgePropertyGroup
    Implicit
    This member is added by an implicit conversion from EdgePropertyGroup to Ensuring[EdgePropertyGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): EdgePropertyGroup
    Implicit
    This member is added by an implicit conversion from EdgePropertyGroup to Ensuring[EdgePropertyGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): EdgePropertyGroup
    Implicit
    This member is added by an implicit conversion from EdgePropertyGroup to Ensuring[EdgePropertyGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def getData(filter: Column): DataFrame

    Returns a filtered view of the data for the property group, with an optional mask applied to IDs.

    Returns a filtered view of the data for the property group, with an optional mask applied to IDs.

    filter

    A condition (Column) used to filter the data.

    returns

    A DataFrame containing the filtered and optionally transformed data.

    Attributes
    protected[graphframes]
    Definition Classes
    EdgePropertyGroup → PropertyGroup
  18. def getData(): DataFrame

    Returns a view of the data for the property group without applying any filter.

    Returns a view of the data for the property group without applying any filter.

    returns

    A DataFrame containing the raw data.

    Attributes
    protected[graphframes]
    Definition Classes
    PropertyGroup
  19. val isDirected: Boolean
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val name: String
    Definition Classes
    EdgePropertyGroup → PropertyGroup
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. val srcColumnName: String
  26. val srcPropertyGroup: VertexPropertyGroup
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def validate(): EdgePropertyGroup.this.type
    Attributes
    protected
    Definition Classes
    EdgePropertyGroup → PropertyGroup
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. val weightColumnName: String
  33. def →[B](y: B): (EdgePropertyGroup, B)
    Implicit
    This member is added by an implicit conversion from EdgePropertyGroup to ArrowAssoc[EdgePropertyGroup] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from EdgePropertyGroup to StringFormat[EdgePropertyGroup] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from PropertyGroup

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from EdgePropertyGroup to any2stringadd[EdgePropertyGroup]

Inherited by implicit conversion StringFormat from EdgePropertyGroup to StringFormat[EdgePropertyGroup]

Inherited by implicit conversion Ensuring from EdgePropertyGroup to Ensuring[EdgePropertyGroup]

Inherited by implicit conversion ArrowAssoc from EdgePropertyGroup to ArrowAssoc[EdgePropertyGroup]

Ungrouped