Property (Neo4j Cypher DSL (Core) 2022.6.1 API)

All Superinterfaces:

Expression, IdentifiableElement, Visitable
```
@API(status=STABLE,
     since="1.0")
public interface Property
extends Expression, IdentifiableElement
```
A property. A property might belong to a container such as a Node or Relationship, but it's not uncommon to extract single properties from maps or from various datatypes such as a duration returned from stored procedures. The container can be retrieved via getContainer() in case the property belongs to a node or relationship.
A property has always a reference to the name of the object it was extracted from.

Since:

1.0

Author:

Michael J. Simons

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`@NotNull Named`	`getContainer()`
`@NotNull String`	`getName()`	Returns the concatenated names of the property or the external reference (See `referencedAs(String)`) if set.
`@NotNull List<PropertyLookup>`	`getNames()`
`@NotNull Property`	`referencedAs(String newReference)`	Creates a new property with an external reference.
`@NotNull Operation`	`to(Expression expression)`	Creates an `Operation` setting this property to a new value.

Methods inherited from interface org.neo4j.cypherdsl.core.Expression
add, as, as, ascending, asCondition, concat, contains, descending, divide, endsWith, eq, gt, gte, hasSize, in, isEmpty, isEqualTo, isFalse, isNotEqualTo, isNotNull, isNull, isTrue, lt, lte, matches, matches, multiply, ne, pow, property, remainder, size, sorted, startsWith, subtract

Methods inherited from interface org.neo4j.cypherdsl.core.IdentifiableElement
asExpression

Methods inherited from interface org.neo4j.cypherdsl.core.ast.Visitable
accept

- Method Detail
  - getName
```
@API(status=STABLE,
     since="2021.1.0")
@NotNull
@Contract(pure=true)
@NotNull String getName()
```
    Returns the concatenated names of the property or the external reference (See referencedAs(String)) if set.
    
    Returns:
    
    A name to reference the property under in an external application
  - getNames
```
@NotNull
@Contract(pure=true)
@NotNull List<PropertyLookup> getNames()
```
    Returns:
    
    The actual property being looked up. The order matters, so this will return a list, not a collection.
  - getContainer
```
@NotNull
@Contract(pure=true)
@NotNull Named getContainer()
```
  - referencedAs
```
@API(status=STABLE,
     since="2021.1.0")
@NotNull
@Contract(pure=true)
@NotNull Property referencedAs(String newReference)
```
    Creates a new property with an external reference.
    
    Parameters:
    
    newReference - An arbitrary, external reference
    
    Returns:
    
    A new property
  - to
```
@NotNull
@Contract(pure=true)
@NotNull Operation to(Expression expression)
```
    Creates an Operation setting this property to a new value. The property does not track the operations created with this method.
    
    Parameters:
    
    expression - expression describing the new value
    
    Returns:
    
    A new operation.