public abstract class

BlockTarget

extends Object
implements Serializable
java.lang.Object
   ↳ com.microstrategy.web.blocks.BlockTarget
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This class represents the "target" of a Block path specification: a property, a list or a Block.

Summary

Nested Classes
class BlockTarget.PathInfo This class provides additional information used in the resolution of a Block path specification. 
Constants
int TARGETTYPE_BLOCK A Block target
int TARGETTYPE_LIST A List target
int TARGETTYPE_PROPERTY A Property target
Public Methods
Iterator<BlockProperty> findProperties(String propName, boolean unique)
Returns an Iterator of all BlockProperties with a given name.
int getTargetType()
Returns the type of this target.
BlockTarget resolvePath(String path)
Resolves a path specification to a BlockTarget object.
BlockTarget resolvePath(String path, BlockTarget.PathInfo pathInfo)
Resolve the specified path to return the targeted object.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int TARGETTYPE_BLOCK

A Block target

Constant Value: 3 (0x00000003)

public static final int TARGETTYPE_LIST

A List target

Constant Value: 2 (0x00000002)

public static final int TARGETTYPE_PROPERTY

A Property target

Constant Value: 1 (0x00000001)

Public Methods

public Iterator<BlockProperty> findProperties (String propName, boolean unique)

Returns an Iterator of all BlockProperties with a given name.

Parameters
propName The name of the BlockProperty to inspect.
unique Whether the list should only contain a unique list of BlockProperty values.
Returns
  • An Iterator of BlockProperty instances.

public int getTargetType ()

Returns the type of this target.

Returns
  • The type of this target.

public BlockTarget resolvePath (String path)

Resolves a path specification to a BlockTarget object.

Parameters
path The path to this object.
Returns
Throws
Exception if the path is malformed or does not refer to a non-null BlockTarget.

public BlockTarget resolvePath (String path, BlockTarget.PathInfo pathInfo)

Resolve the specified path to return the targeted object.

Parameters
path The path to the object that the caller seeks.
pathInfo Information about the path that has been processed.
Returns
  • The target object described by the path.
Throws
Exception If the path could not be resolved.