Class ContextURL

java.lang.Object
org.apache.olingo.commons.api.data.ContextURL

public final class ContextURL extends Object
High-level representation of a context URL, built from the string value returned by a service; provides access to the various components of the context URL, defined in the protocol specification.
  • Method Details

    • getODataPath

      public String getODataPath()
      Get the OData path.
      Returns:
      the OData path
    • getServiceRoot

      public URI getServiceRoot()
      Get the service root.
      Returns:
      the service root
    • getEntitySetOrSingletonOrType

      public String getEntitySetOrSingletonOrType()
      Get the set entity set / singleton / type.
      Returns:
      the entity set / singleton / type
    • isCollection

      public boolean isCollection()
      Is context result a collection.
      Returns:
      true for a collection, otherwise false
    • getDerivedEntity

      public String getDerivedEntity()
      Get the derived entity.
      Returns:
      derived entity
    • getSelectList

      public String getSelectList()
      Get the select list.
      Returns:
      the select list
    • getNavOrPropertyPath

      public String getNavOrPropertyPath()
      Get the set navigation or property path.
      Returns:
      the set navigation or property path
    • getKeyPath

      public String getKeyPath()
      Get the set key path.
      Returns:
      the set key path
    • getSuffix

      public ContextURL.Suffix getSuffix()
      Get the set suffix.
      Returns:
      the set suffix
    • isEntity

      public boolean isEntity()
      Is context result a entity.
      Returns:
      true for a reference, otherwise false
    • isReference

      public boolean isReference()
      Is context result a reference.
      Returns:
      true for a reference, otherwise false
    • isDelta

      public boolean isDelta()
      Is context result a delta result.
      Returns:
      true for a delta result, otherwise false
    • isDeltaDeletedEntity

      public boolean isDeltaDeletedEntity()
      Is context result a delta deleted entity.
      Returns:
      true for a delta deleted entity, otherwise false
    • isDeltaLink

      public boolean isDeltaLink()
      Is context result a delta link.
      Returns:
      true for a delta link, otherwise false
    • isDeltaDeletedLink

      public boolean isDeltaDeletedLink()
      Is context result a delta deleted link.
      Returns:
      true for a delta deleted link, otherwise false
    • with

      public static ContextURL.Builder with()
      Start building a ContextURL instance.
      Returns:
      builder for building a ContextURL instance