com.sapportals.wcm.util.uri

Class URI

java.lang.Object
  com.sapportals.wcm.util.uri.URI

All Implemented Interfaces:

Comparable

Deprecated. as of EP 5.0 SP3, replaced by RID

public final class URI
extends Object
implements Comparable

An URI (better WcmPath) is an identifier for a WCM resource.

An URI holds all information to identify a WCM resource and retrieve it via the WCM Framework. Each WCM resource has its unique URI.

A URI has a path-like structure, like a path in a file system and follows the following production:

   URI         ::= '/' pathsegment | '/' pathsegment '?' query
   pathsegment ::= name | name '/' pathsegment | empty
   name        ::= any char except '/'
   query       ::= parameter | parameter '&' query | empty
   parameter   ::= varname | varname '=' value
   varname     ::= any char except '=', '&'
   value       ::= any character except '&'
 

Equality is defined as ignoring trailing '/' characters. Thus, the URIs "/docs/" and /docs" are considered equal. There is special handling for the root collection "/", which is not equal to the empty URI "".

Copyright (c) SAP AG 2001-2005

Constructor Summary

URI(String uri)
Deprecated. Create a new UTI with given path, without query

URI(String path, String query)
Deprecated. Create a new URI with given path and query string

Method Summary

URI	add(String uri) Deprecated. Concatenate this URI with the given URI.
URI	add(URI uri) Deprecated. Concatenate this URI with the given URI.
URI	addQueryParameter(Properties parameter) Deprecated. as of NW04. Use setQueryParameter
int	compareTo(Object o) Deprecated.
URI	decode() Deprecated. as of NW04. URI objects are never decoded
URI	encode() Deprecated. as of NW04. URI objects are never encoded
boolean	endsWithSlash() Deprecated. Return if this URI ends with a slash.
boolean	equals(Object other) Deprecated. Determine if this URI equals other.
boolean	equals(String other) Deprecated. Determine if this URI equals other.
boolean	equals(URI other) Deprecated. Determine if this URI equals other.
String	extension() Deprecated. Get the extension part of the resource name.
String	getPath() Deprecated. Return the path component of this URI.
String	getQuery() Deprecated. Return the query component of this URI (null if it does not exist).
Properties	getQueryParameter() Deprecated. Get the query parameters of the URI.
int	hashCode() Deprecated.
boolean	isAbsolute() Deprecated. Return if URI is absolute, e.g. start with a slash.
boolean	isAncestorOf(URI child) Deprecated. Determine if this URI is an ancestor (parent or parent's parent, etc.) of the given child URI.
boolean	isRoot() Deprecated. Return if URI is root collection.
int	length() Deprecated. Return length of URI in string representation
URI	name() Deprecated. Get the name of the resource, designated by this URI.
URI	parent() Deprecated. Get the URI of the parent collection of this URI
URI	removeExtension() Deprecated. Remove the (optional) extension of the resource name.
URI	removeName() Deprecated. Remove the name of the resource, same as parent()
URI	removeRoot() Deprecated. Get a new URI with the toplevel collection removed
URI	removeTrailingSlash() Deprecated. Remove a possible trailing slash from the URI.
URI	resolveRelativeURI(String uri) Deprecated. Resolve relative URIs
URI	root() Deprecated. Get URI of toplevel collection (below root) of this URI.
URI	setQueryParameter(Properties parameter) Deprecated. Create a new URI by setting the given parameters as query part of this URI.
List	split() Deprecated. Splits the URI into its path components
String	toExternalForm() Deprecated. Convert this URI to a representation usable in W3C Uri References.
String	toString() Deprecated. Returns string representation of this URI

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

URI

public URI(String path,
           String query)

Deprecated.

Create a new URI with given path and query string

Parameters:

path - of URI

query - part or URI (can be null)

URI

public URI(String uri)

Deprecated.

Create a new UTI with given path, without query

Method Detail

encode

public URI encode()

Deprecated. as of NW04. URI objects are never encoded

decode

public URI decode()

Deprecated. as of NW04. URI objects are never decoded

toExternalForm

public String toExternalForm()

Deprecated.

Convert this URI to a representation usable in W3C Uri References. Non-ascii and reserved characters are encoded.

Note that such an encoded string cannot be used to construct an new URI object! The path in URI objects is never, ever encoded.

Returns:

URI in W3C string representation

getPath

public String getPath()

Deprecated.

Return the path component of this URI.

Returns:

the path component

getQuery

public String getQuery()

Deprecated.

Return the query component of this URI (null if it does not exist).

Returns:

the query component

getQueryParameter

public Properties getQueryParameter()

Deprecated.

Get the query parameters of the URI. Will return an empty Properties object if URI has no query part. Modifying the Properties object has no effect on the URI itself.

Returns:

query parameters as Properties

root

public URI root()

Deprecated.

Get URI of toplevel collection (below root) of this URI.

The root URI of a toplevel collection is the root collection URI. The root URI of the root URI is the root URI itself.

Returns:

URI of toplevel collection below root

name

public URI name()

Deprecated.

Get the name of the resource, designated by this URI. If the URI has query parameter, these are discarded.

Returns:

the name of the resource, designated by this URI

parent

public URI parent()

Deprecated.

Get the URI of the parent collection of this URI

Returns:

the URI of the parent collection

extension

public String extension()

Deprecated.

Get the extension part of the resource name. Returns the empty string if there is no extension.

Returns:

the extension part of the resource name

removeRoot

public URI removeRoot()

Deprecated.

Get a new URI with the toplevel collection removed

Returns:

URI with toplevel collection removed

removeName

public URI removeName()

Deprecated.

Remove the name of the resource, same as parent()

Returns:

parent of the resource

removeExtension

public URI removeExtension()

Deprecated.

Remove the (optional) extension of the resource name. Query parameters are discarded.

Returns:

uri with extension of name removed

removeTrailingSlash

public URI removeTrailingSlash()

Deprecated.

Remove a possible trailing slash from the URI. Query parameters are preserved.

Returns:

URI without trailing slash

isAbsolute

public boolean isAbsolute()

Deprecated.

Return if URI is absolute, e.g. start with a slash.

Returns:

if URI is absolute path

isRoot

public boolean isRoot()

Deprecated.

Return if URI is root collection.

Returns:

if this is the root collection

isAncestorOf

public boolean isAncestorOf(URI child)

Deprecated.

Determine if this URI is an ancestor (parent or parent's parent, etc.) of the given child URI.

Parameters:

child - to test against

Returns:

if this URI is ancestor of child

endsWithSlash

public boolean endsWithSlash()

Deprecated.

Return if this URI ends with a slash.

Returns:

if this URI ends with a slash

add

public URI add(String uri)

Deprecated.

Concatenate this URI with the given URI. Treats this URI as if it ends with a slash and the parameter URI as if it starts without a slash.

Parameters:

uri - to append to this

Returns:

new URI as concatenation

add

public URI add(URI uri)

Deprecated.

Concatenate this URI with the given URI. Treats this URI as if it ends with a slash and the parameter URI as if it starts without a slash.

Parameters:

uri - to append to this

Returns:

new URI as concatenation

split

public List split()

Deprecated.

Splits the URI into its path components

Returns:

List of Strings

toString

public String toString()

Deprecated.

Returns string representation of this URI

Overrides:

toString in class Object

Returns:

this URI as string

equals

public boolean equals(URI other)

Deprecated.

Determine if this URI equals other.

Parameters:

other - URI

Returns:

if this URI equals other

equals

public boolean equals(String other)

Deprecated.

Determine if this URI equals other.

Parameters:

other - URI (string representation)

Returns:

if this URI equals other

equals

public boolean equals(Object other)

Deprecated.

Determine if this URI equals other. Equality is defined for instances of URI only.

Overrides:

equals in class Object

Parameters:

other -

Returns:

if this URI equals other

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

length

public int length()

Deprecated.

Return length of URI in string representation

Returns:

length of URI in string representation

resolveRelativeURI

public URI resolveRelativeURI(String uri)

Deprecated.

Resolve relative URIs

Parameters:

uri - An URI, which may be relative or absolute

addQueryParameter

public URI addQueryParameter(Properties parameter)

Deprecated. as of NW04. Use setQueryParameter

Create a new URI by setting the given parameters as query part of this URI.

Parameters:

parameter - to set to query

Returns:

new URI with parameter in query

setQueryParameter

public URI setQueryParameter(Properties parameter)

Deprecated.

Create a new URI by setting the given parameters as query part of this URI.

Parameters:

parameter - to set to query

Returns:

new URI with parameter in query

compareTo

public int compareTo(Object o)

Deprecated.

Specified by:

compareTo in interface Comparable

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM