@API(status=INTERNAL,
since="6.0")
public interface RelationshipDescription
NodeDescription
reachable in the Schema
via it's primary label defined by
getTarget()
.Modifier and Type | Field and Description |
---|---|
static String |
NAME_OF_RELATIONSHIP |
static String |
NAME_OF_RELATIONSHIP_TYPE |
Modifier and Type | Method and Description |
---|---|
default String |
generateRelatedNodesCollectionName(NodeDescription<?> mostAbstractNodeDescription) |
Relationship.Direction |
getDirection()
The direction of the defined relationship.
|
String |
getFieldName()
The name of the property where the relationship was defined.
|
RelationshipDescription |
getRelationshipObverse() |
NodeDescription<?> |
getRelationshipPropertiesEntity()
If this is a relationship with properties, the properties-defining class will get returned, otherwise
null.
|
NodeDescription<?> |
getSource()
The source of this relationship is described by the primary label of the node in question.
|
NodeDescription<?> |
getTarget()
The target of this relationship is described by the primary label of the node in question.
|
String |
getType()
If this relationship is dynamic, than this method always returns the name of the inverse property.
|
default boolean |
hasInternalIdProperty() |
boolean |
hasRelationshipObverse()
Checks if there is a relationship description describing the obverse of this relationship.
|
boolean |
hasRelationshipProperties()
Tells if this relationship is a relationship with additional properties.
|
boolean |
isDynamic()
A relationship is dynamic when it's modelled as a {@code Map |
default boolean |
isIncoming() |
default boolean |
isOutgoing() |
void |
setRelationshipObverse(RelationshipDescription relationshipObverse)
Set the relationship definition that describes the opposite side of the relationship.
|
static final String NAME_OF_RELATIONSHIP
static final String NAME_OF_RELATIONSHIP_TYPE
String getType()
boolean isDynamic()
Map<String, ?>
.NodeDescription<?> getSource()
NodeDescription<?> getTarget()
String getFieldName()
Relationship.Direction getDirection()
@Nullable NodeDescription<?> getRelationshipPropertiesEntity()
boolean hasRelationshipProperties()
getRelationshipPropertiesClass
will return the type of the properties holding class.default boolean hasInternalIdProperty()
default boolean isOutgoing()
default boolean isIncoming()
@NonNull default String generateRelatedNodesCollectionName(NodeDescription<?> mostAbstractNodeDescription)
void setRelationshipObverse(RelationshipDescription relationshipObverse)
relationshipObverse
- logically same relationship definition in the target entityRelationshipDescription getRelationshipObverse()
boolean hasRelationshipObverse()
Copyright © 2019–2021 Neo4j, Neo4j Sweden AB. All rights reserved.