case class EdgePropertyGroup(name: String, data: DataFrame, srcPropertyGroup: VertexPropertyGroup, dstPropertyGroup: VertexPropertyGroup, isDirected: Boolean, srcColumnName: String, dstColumnName: String, weightColumnName: String) 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
- name
Unique identifier for this edge property group
- data
DataFrame containing the edge data with required columns
- srcPropertyGroup
Source vertex property group
- dstPropertyGroup
Destination vertex property group
- isDirected
Whether edges should be treated as directed (true) or undirected (false)
- srcColumnName
Name of the source vertex column in the data
- dstColumnName
Name of the destination vertex column in the data
- weightColumnName
Name of the edge weight column in the data
- 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.
- Alphabetic
- By Inheritance
- EdgePropertyGroup
- Serializable
- Product
- Equals
- PropertyGroup
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new EdgePropertyGroup(name: String, data: DataFrame, srcPropertyGroup: VertexPropertyGroup, dstPropertyGroup: VertexPropertyGroup, isDirected: Boolean, srcColumnName: String, dstColumnName: String, weightColumnName: String)
- name
Unique identifier for this edge property group
- data
DataFrame containing the edge data with required columns
- srcPropertyGroup
Source vertex property group
- dstPropertyGroup
Destination vertex property group
- isDirected
Whether edges should be treated as directed (true) or undirected (false)
- srcColumnName
Name of the source vertex column in the data
- dstColumnName
Name of the destination vertex column in the data
- weightColumnName
Name of the edge weight column in the data
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from EdgePropertyGroup toany2stringadd[EdgePropertyGroup] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (EdgePropertyGroup, B)
- Implicit
- This member is added by an implicit conversion from EdgePropertyGroup toArrowAssoc[EdgePropertyGroup] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val data: DataFrame
- Definition Classes
- EdgePropertyGroup → PropertyGroup
- val dstColumnName: String
- val dstPropertyGroup: VertexPropertyGroup
- def ensuring(cond: (EdgePropertyGroup) => Boolean, msg: => Any): EdgePropertyGroup
- Implicit
- This member is added by an implicit conversion from EdgePropertyGroup toEnsuring[EdgePropertyGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (EdgePropertyGroup) => Boolean): EdgePropertyGroup
- Implicit
- This member is added by an implicit conversion from EdgePropertyGroup toEnsuring[EdgePropertyGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): EdgePropertyGroup
- Implicit
- This member is added by an implicit conversion from EdgePropertyGroup toEnsuring[EdgePropertyGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): EdgePropertyGroup
- Implicit
- This member is added by an implicit conversion from EdgePropertyGroup toEnsuring[EdgePropertyGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- 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
- 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
- val isDirected: Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val name: String
- Definition Classes
- EdgePropertyGroup → PropertyGroup
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val srcColumnName: String
- val srcPropertyGroup: VertexPropertyGroup
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def validate(): EdgePropertyGroup.this.type
- Attributes
- protected
- Definition Classes
- EdgePropertyGroup → PropertyGroup
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- val weightColumnName: String
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from EdgePropertyGroup toStringFormat[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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (EdgePropertyGroup, B)
- Implicit
- This member is added by an implicit conversion from EdgePropertyGroup toArrowAssoc[EdgePropertyGroup] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.