Record Class EntityResultSegment

java.lang.Object

java.lang.Record

org.apache.cayenne.query.EntityResultSegment

Record Components:

classDescriptor - a descriptor of the entity mapped by this segment

fields - a map of ResultSet labels keyed by column paths. Note that ordering of fields in the map is generally undefined and should not be relied upon when processing query result sets.

columnOffset - a zero-based column index of the first column of this segment in the ResultSet

All Implemented Interfaces:

ResultSegment

public record EntityResultSegment(ClassDescriptor classDescriptor, Map<String,String> fields, int columnOffset)
extends Record
implements ResultSegment

A "compiled" version of a EntityResult descriptor.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
EntityResultSegment(ClassDescriptor classDescriptor, Map<String,String> fields, int columnOffset)	Creates an instance of a EntityResultSegment record class.

Method Summary

Modifier and Type	Method	Description
ClassDescriptor	classDescriptor()	Returns the value of the classDescriptor record component.
int	columnOffset()	Returns the value of the columnOffset record component.
String	columnPath(String resultSetLabel)	Performs a reverse lookup of the column path for a given ResultSet label.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Map<String,String>	fields()	Returns the value of the fields record component.
final int	hashCode()	Returns a hash code value for this object.
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

EntityResultSegment

public EntityResultSegment(ClassDescriptor classDescriptor,
 Map<String,String> fields,
 int columnOffset)

Creates an instance of a EntityResultSegment record class.

Parameters:

classDescriptor - the value for the classDescriptor record component

fields - the value for the fields record component

columnOffset - the value for the columnOffset record component

Method Details

columnPath

public String columnPath(String resultSetLabel)

Performs a reverse lookup of the column path for a given ResultSet label.

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

classDescriptor

public ClassDescriptor classDescriptor()

Returns the value of the classDescriptor record component.

Returns:

the value of the classDescriptor record component

fields

public Map<String,String> fields()

Returns the value of the fields record component.

Returns:

the value of the fields record component

columnOffset

public int columnOffset()

Returns the value of the columnOffset record component.

Specified by:

columnOffset in interface ResultSegment

Returns:

the value of the columnOffset record component