Package oracle.pgx.api

Class EntityProviderMetaData

java.lang.Object

oracle.pgx.common.Self

oracle.pgx.api.EntityProviderMetaData

Direct Known Subclasses:

EdgeProviderMetaData, VertexProviderMetaData

public abstract class EntityProviderMetaData
extends oracle.pgx.common.Self

Meta information about an entity provider in a PgxGraph.

Since:

3.2.0

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
IdType	getIdType()	Gets the ID type of this entity table.
List<KeyColumnDescriptor>	getKeyColumns()	Get the key columns of this entity provider.
Set<String>	getLabels()	Returns the list of provider labels ("type labels").
String	getName()	Gets the name of this entity table.
List<PropertyMetaData>	getProperties()	Returns a list containing the metadata for the properties associated to this provider.
int	hashCode()
void	setIdType(IdType idType)	Sets the ID type of this entity table.
void	setKeyColumns(List<KeyColumnDescriptor> keyColumns)	Set the key columns of this entity provider.
void	setProperties(List<PropertyMetaData> properties)
String	toString()

Methods inherited from class oracle.pgx.common.Self

addLinks, getCanonicalLink, getId, getLinks, injectLinks, setId, setLinks

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

getKeyColumns

@BetaApi
public List<KeyColumnDescriptor> getKeyColumns()

Get the key columns of this entity provider. Note that key column names may not be available, depending on how this graph was loaded.

Returns:

List of key columns.

Since:

25.2.0

setKeyColumns

@BetaApi
public void setKeyColumns(List<KeyColumnDescriptor> keyColumns)

Set the key columns of this entity provider.

Parameters:

keyColumns - List of key columns.

Since:

25.2.0

getIdType

public IdType getIdType()

Gets the ID type of this entity table.

Returns:

the idType

See Also:

• API with support for multiple key columns

setIdType

public void setIdType(IdType idType)

Sets the ID type of this entity table.

See Also:

• API with support for multiple key columns

getName

public String getName()

Gets the name of this entity table.

Returns:

the table name

getLabels

public Set<String> getLabels()

Returns the list of provider labels ("type labels").

Returns:

the list of provider labels

getProperties

public List<PropertyMetaData> getProperties()

Returns a list containing the metadata for the properties associated to this provider.

Returns:

the list of property metadata

Since:

21.1

setProperties

public void setProperties(List<PropertyMetaData> properties)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object