Interface ArcProperty

All Superinterfaces:
PropertyDescriptor
All Known Subinterfaces:
ToManyMapProperty, ToManyProperty, ToOneProperty
public interface ArcProperty extends PropertyDescriptor
A Property that represents an "arc" connecting source node to the target node in the graph.
Since:
1.2

  • Method Details

    • getRelationship

      ObjRelationship getRelationship()
      Returns a relationship associated with this arc.
      Since:
      3.0

    • getComplementaryReverseDbRelationshipPath

      String getComplementaryReverseDbRelationshipPath()
      Returns a path over reverse DbRelationships for this arc's ObjRelationship.
      Since:
      5.0

    • getComplementaryReverseArc

      ArcProperty getComplementaryReverseArc()
      Returns a complementary reverse ArcProperty or null if no reverse arc exists.
      Since:
      5.0

    • getComplimentaryReverseDbRelationshipPath

      @Deprecated(since="5.0", forRemoval=true) default String getComplimentaryReverseDbRelationshipPath()
      Deprecated, for removal: This API element is subject to removal in a future version.
      misspelled, use getComplementaryReverseDbRelationshipPath()

    • getComplimentaryReverseArc

      @Deprecated(since="5.0", forRemoval=true) default ArcProperty getComplimentaryReverseArc()
      Deprecated, for removal: This API element is subject to removal in a future version.
      misspelled, use getComplementaryReverseArc()

    • getTargetDescriptor

      ClassDescriptor getTargetDescriptor()
      Returns a ClassDescriptor for the type of graph nodes pointed to by this arc property. Note that considering that a target object may be a subclass of the class handled by the descriptor, users of this method may need to call ClassDescriptor.getSubclassDescriptor(String) before using the descriptor to access objects.

    • isFault

      @Deprecated(since="5.0", forRemoval=true) default boolean isFault(Object source)
      Deprecated, for removal: This API element is subject to removal in a future version.
      in favor of isFaultValue(Object), that lets the caller check and use a single read of the property.
      Returns whether a target node connected to a given object is an unresolved fault.
      Parameters:
      source - an object that is a source object of the relationship.

    • isFaultValue

      boolean isFaultValue(Object value)
      Returns whether a value of this property, as returned by PropertyDescriptor.readPropertyDirectly(Object), is an unresolved fault. Unlike isFault(Object), this lets the caller decide on a single read of the property, which matters when another thread may resolve the fault between two reads of the same object.
      Parameters:
      value - a value of this property read from a source object.
      Since:
      5.0

    • invalidate

      void invalidate(Object object)
      Turns a property of an object into a fault.
      Since:
      3.0