Interface Property

  • All Superinterfaces:
    Expression, Visitable

    @API(status=EXPERIMENTAL,
         since="1.0")
    public interface Property
    extends Expression
    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 Detail

      • getName

        @API(status=EXPERIMENTAL,
             since="2021.1.0")
        java.lang.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

        java.util.List<PropertyLookup> getNames()
        Returns:
        The actual property being looked up. The order matters, so this will return a list, not a collection.
      • getContainer

        Named getContainer()
      • referencedAs

        @API(status=EXPERIMENTAL,
             since="2021.1.0")
        Property referencedAs​(java.lang.String newReference)
        Creates a new property with an external reference.
        Parameters:
        newReference - An arbitrary, external reference
        Returns:
        A new property
      • to

        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.