DefaultURIBuilderImpl

extends AbstractConfigurableParameterBuilder

java.lang.Object
↳	com.microstrategy.web.platform.AbstractParameterBuilder
	↳	com.microstrategy.web.platform.AbstractConfigurableParameterBuilder
		↳	com.microstrategy.web.platform.DefaultURIBuilderImpl

Class Overview

The default URI Builder for the Web Universal application.

Summary

[Expand]

Inherited Fields

From class com.microstrategy.web.platform.AbstractParameterBuilder

Public Constructors
	DefaultURIBuilderImpl()

Public Methods
void	addFragment(String fragment) Adds a fragment of key/value pairs.
boolean	isEmpty() This method returns `true` if no target base was added nor any parameters.
String	toString() Get the entire collection of parameters as a string.

[Expand]

Inherited Methods

From class com.microstrategy.web.platform.AbstractConfigurableParameterBuilder

From class com.microstrategy.web.platform.AbstractParameterBuilder

void	addEventInfo(WebEvent event, int eventElements, int howMuchChildState) Adds into the current object the event information in the format of key/value pairs.
void	addParameter(String name, String value) Add a name/value pair.
static boolean	areAllBitsSet(int intVal, int bits) Determines whether the specified integer value has set all its bits specified through the the parameter `bits`.
NamespaceEncoder	getNamespaceEncoder() The current `NamespaceEncoder` associated with this ParameterBuilder.
Iterator	getParameters() Return an iterator for the list of parameters.
String	getTargetBase() Returns the target base supplied to this ParameterBuilder via `setTargetBase(String)`.
String	getTargetPrefix() Returns the target prefix supplied to this ParameterBuilder via `setTargetPrefix(String)`.
String	getTargetSuffix() Returns the target suffix supplied to this ParameterBuilder via `setTargetSuffix(String)`.
void	init(Object parent) Initializes this class by attaching up a namespace encoder (as provided by the parent).
static boolean	isAnyBitSet(int intVal, int bits) Determines whether the specified integer value has set any bit specified through the the parameter `bits`.
void	parseEntireURLStringFragment(String fragment) This method parses a string fragment that is belived to contain an entire URL (base URI plus zero or more parameters).
void	parseURLParameterFragment(String fragment) This method parses a string fragment that is believed to contain only URL parameters ("...&key1=value1&...").
void	setInitialSize(int chars) The initial size of the `ParameterBuilder` in number of characters.
void	setNamespaceEncoder(NamespaceEncoder nse) Assign the supplied `NamespaceEncoder` to this ParameterBuilder instance.
void	setTargetBase(String targetBase) Specify a target base URI (for URL generation).
void	setTargetPrefix(String targetPrefix) Specifies a prefix string to appear before the Target Base.
void	setTargetSuffix(String targetSuffix) Specifies a suffix string to appear after the Target Base.

From class java.lang.Object

From interface com.microstrategy.web.platform.ParameterBuilder

abstract void	addEventInfo(WebEvent event, int eventElements, int howMuchChildState) Add the event information, which is represented in key/value pairs.
abstract void	addFragment(String fragment) Add a fragment of key/value pairs.
abstract void	addParameter(String name, String value) Add a name/value pair.
abstract NamespaceEncoder	getNamespaceEncoder() Each ParameterBuilder instance is associated with a NamespaceEncoder instance that is may choose to use for encoding a namespace into the output form.
abstract String	getTargetBase() Returns the target base supplied to this ParameterBuilder via `setTargetBase(String)`.
abstract String	getTargetPrefix() Returns the target prefix supplied to this ParameterBuilder via `setTargetPrefix(String)`.
abstract String	getTargetSuffix() Returns the target suffix supplied to this ParameterBuilder via `setTargetSuffix(String)`.
abstract void	init(Object parent) Initialize this object (supplying the parent object as the only parameter).
abstract boolean	isEmpty() This method returns `true` if no target base was added nor any parameters.
abstract void	setInitialSize(int chars) Set the initial size for this ParameterBuilder object.
abstract void	setNamespaceEncoder(NamespaceEncoder nse) This method can be used to set the `NamespaceEncoder` object used with this ParameterBuilder instance.
abstract void	setTargetBase(String targetBase) Specify a target base URI (for URL generation).
abstract void	setTargetPrefix(String targetPrefix) Specifies a prefix string to appear before the Target Base.
abstract void	setTargetSuffix(String targetSuffix) Specifies a suffix string to appear after the Target Base.
abstract String	toString() Get the entire collection of parameters as a string.

Public Constructors

public DefaultURIBuilderImpl ()

Public Methods

public void addFragment (String fragment)

Adds a fragment of key/value pairs.

Parameters

fragment	A string fragment which must be parsed for a sequence of key/value pairs.

public boolean isEmpty ()

This method returns true if no target base was added nor any parameters. It is not related to whether a target prefix/suffix was added. It is identical to asking whether the returned string (if requested now) would return empty or not.

Returns

Whether the ParameterBuilder object is essentially empty or not.

public String toString ()

Get the entire collection of parameters as a string.

Returns

A string representation of the set of key/value pairs.

Interfaces

Classes

Enums

Exceptions

DefaultURIBuilderImpl

Class Overview

Summary

Public Constructors

public DefaultURIBuilderImpl ()

Public Methods

public void addFragment (String fragment)

Parameters

public boolean isEmpty ()

Returns

public String toString ()

Returns