Package com.microstrategy.web.blocks

Class BlockTarget.PathInfo

  • Enclosing class:
    BlockTarget
    public static class BlockTarget.PathInfo
extends java.lang.Object
    This class provides additional information used in the resolution of a Block path specification. It is used when BlockTarget.resolvePath(String) does not provide enough information for the caller. This is only to be used in very specialized scenarios.
    Since:
    MicroStrategy Web 9.0.0

    • Constructor Summary

      Constructors 
      Constructor Description
      PathInfo()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean getAllTokensConsumed()
      Returns whether all tokens were consumed as part of the path resolution process.
      boolean getFailed()
      Whether the resolution of the path has currently ended in failure or not.
      java.lang.String getFailureMessage()
      If the path resolution has failed, this is the message that describes why.
      BlockTarget getInnermostBlockTarget()
      Returns the innermost BlockTarget visited as part of the path resolution.
      java.lang.Object getInnermostIndex()
      Returns the "index" of the innermost BlockTarget visited as part of the path resolution.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PathInfo

        public PathInfo()

    • Method Detail

      • getFailed

        public boolean getFailed()
        Whether the resolution of the path has currently ended in failure or not.
        Returns:
        True if the resolution has failed; otherwise false.

      • getFailureMessage

        public java.lang.String getFailureMessage()
        If the path resolution has failed, this is the message that describes why.
        Returns:
        The failure message associated with path resolution.

      • getInnermostBlockTarget

        public BlockTarget getInnermostBlockTarget()
        Returns the innermost BlockTarget visited as part of the path resolution. This works even if the path is invalid. Each valid BlockTarget visited is recorded up to the end of path resolution.
        Returns:
        The innermost BlockTarget visited.

      • getInnermostIndex

        public java.lang.Object getInnermostIndex()
        Returns the "index" of the innermost BlockTarget visited as part of the path resolution. The "index" of a BlockList is either the numeric index or symbolic key. The "index" of a Block is the property looked up. There is no "index" for a BlockProperty.
        Returns:
        The index used with the innermost BlockTarget.

      • getAllTokensConsumed

        public boolean getAllTokensConsumed()
        Returns whether all tokens were consumed as part of the path resolution process.
        Returns:
        Whether all tokens were consumed as part of the path resolution process.