Record Class ModelRelationshipRead

java.lang.Object

java.lang.Record

io.fluxzero.common.api.modeling.ModelRelationshipRead

Record Components:

modelId - canonical identity at the source of the selection

direction - whether incoming children or outgoing parents were selected

path - exact persisted relationship path, or null for all paths

public record ModelRelationshipRead(String modelId, ModelRelationshipRead.Direction direction, String path)
extends Record

A relationship selection observed at the commit's read boundary, including a selection that returned no edges. Values of the selected Models are separate head dependencies. A null path selects every relationship path; an empty path selects only pathless relationships. Type filtering is conservatively protected at path granularity.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ModelRelationshipRead.Direction	Direction relative to the observed Model.

Constructor Summary

Constructors

Constructor	Description
ModelRelationshipRead(String modelId, ModelRelationshipRead.Direction direction, String path)	Creates an instance of a ModelRelationshipRead record class.

Method Summary

Modifier and Type	Method	Description
ModelRelationshipRead.Direction	direction()	Returns the value of the direction record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	matches(String childId, ModelRelationship relationship)	Whether an edge belongs to this selection, independently of its temporal validity.
String	modelId()	Returns the value of the modelId record component.
String	path()	Returns the value of the path record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ModelRelationshipRead

public ModelRelationshipRead(String modelId,
 ModelRelationshipRead.Direction direction,
 String path)

Creates an instance of a ModelRelationshipRead record class.

Parameters:

modelId - the value for the modelId record component

direction - the value for the direction record component

path - the value for the path record component

Method Details

matches

public boolean matches(String childId,
 ModelRelationship relationship)

Whether an edge belongs to this selection, independently of its temporal validity.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

modelId

public String modelId()

Returns the value of the modelId record component.

Returns:

the value of the modelId record component

direction

public ModelRelationshipRead.Direction direction()

Returns the value of the direction record component.

Returns:

the value of the direction record component

path

public String path()

Returns the value of the path record component.

Returns:

the value of the path record component