Package org.knime.core.webui.node

Record Class PagePathSegments

java.lang.Object
java.lang.Record
org.knime.core.webui.node.PagePathSegments
Record Components:
pathPrefix - the path prefix more or less encoding the ui-extension type (view, dialog etc.) - see PageResourceManager.getPagePathPrefix(org.knime.core.webui.node.PageResourceManager.PageType)
pageId - the page-id which is essentially tied to a Page-instance. As a result it is build differently depending on whether the page is static, 'static-reusable' or non-static (see PageCache.PageIdType) - because these page-instances have different life cycles (e.g. there will be only one single instance of a 'static-reusable' page across different node instances and ui-extension-types)
pageContentId - a optional path segment (i.e. can be null) reflecting the content of the page
relativePagePath - the relative path to the actual page(-resource)
public record PagePathSegments(String pathPrefix, String pageId, String pageContentId, String relativePagePath) extends Record
The path segments that contribute to a page path as it's returned by PageResourceManager.getPagePath(NodeWrapper).
Author:
Martin Horn, KNIME GmbH, Konstanz, Germany

  • Constructor Details

    • PagePathSegments

      public PagePathSegments(String pathPrefix, String pageId, String pageContentId, String relativePagePath)
      Creates an instance of a PagePathSegments record class.
      Parameters:
      pathPrefix - the value for the pathPrefix record component
      pageId - the value for the pageId record component
      pageContentId - the value for the pageContentId record component
      relativePagePath - the value for the relativePagePath record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • pathPrefix

      public String pathPrefix()
      Returns the value of the pathPrefix record component.
      Returns:
      the value of the pathPrefix record component

    • pageId

      public String pageId()
      Returns the value of the pageId record component.
      Returns:
      the value of the pageId record component

    • pageContentId

      public String pageContentId()
      Returns the value of the pageContentId record component.
      Returns:
      the value of the pageContentId record component

    • relativePagePath

      public String relativePagePath()
      Returns the value of the relativePagePath record component.
      Returns:
      the value of the relativePagePath record component