public static class

BlockTarget.PathInfo

extends Object
java.lang.Object
   ↳ com.microstrategy.web.blocks.BlockTarget.PathInfo

Class Overview

This class provides additional information used in the resolution of a Block path specification. It is used when resolvePath(String) does not provide enough information for the caller. This is only to be used in very specialized scenarios.

Summary

Public Constructors
PathInfo()
Public Methods
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.
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.
Object getInnermostIndex()
Returns the "index" of the innermost BlockTarget visited as part of the path resolution.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PathInfo ()

Public Methods

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.

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.

public String getFailureMessage ()

If the path resolution has failed, this is the message that describes why.

Returns
  • The failure message associated with path resolution.

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

public 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