public interface IRid
A Rid has a path-like structure, like a path in a file system and follows the following production:
Rid ::= '/' pathsegment | '/' pathsegment '?' query pathsegment ::= name | name '/' pathsegment | empty name ::= any char except '/' query ::= parameter | parameter 'and' query | empty parameter ::= varname | varname '=' value varname ::= any char except '=', 'and' value ::= any character except 'and'Equality is defined as ignoring trailing '/' characters. Thus, the Rids "/docs/" and /docs" are considered equal. There is special handling for the root collection "/", which is not equal to the empty Rid "".
Copyright (c) SAP AG 2001-2003
Modifier and Type | Method and Description |
---|---|
IRid |
add(IRid uri)
Concatenate this Rid with the given Rid.
|
IRid |
add(String uri)
Concatenate this Rid with the given Rid.
|
IRid |
addPathSegment(String segment)
Adds a path segment.
|
boolean |
endsWithSlash()
Return if this Rid ends with a slash.
|
String |
extension()
Get the extension part of the resource name.
|
String |
getPath()
Return the path component of this Rid.
|
String |
getQuery()
Return the query component of this Rid (null if it does not exist).
|
Properties |
getQueryParameter()
Get the query parameters of the Rid.
|
boolean |
isAbsolute()
Return if Rid is absolute, e.g. start with a slash.
|
boolean |
isAncestorOf(IRid child)
Determine if this Rid is an ancestor (parent or parent's parent, etc.) of
the given child Rid.
|
boolean |
isAncestorOfOrSelf(IRid child)
Determine if this Rid is an ancestor (parent or parent's parent, etc.) of
the given child Rid or the same.
|
boolean |
isRoot()
Return if Rid is root collection.
|
int |
length()
Return length of Rid in string representation
|
IRid |
name()
Get the name of the resource, designated by this Rid.
|
IRid |
parent()
Get the Rid of the parent collection of this Rid
|
IRid |
removeExtension()
Remove the (optional) extension of the resource name.
|
IRid |
removeName()
Remove the name of the resource, same as parent()
|
IRid |
removeRoot()
Get a new Rid with the toplevel collection removed
|
IRid |
removeTrailingSlash()
Remove a possible trailing slash from the Rid.
|
IRid |
resolveRelativeRid(String uri)
Resolve relative Rids
|
IRid |
root()
Get Rid of toplevel collection (below root) of this Rid.
|
IRid |
setQueryParameter(Properties parameter)
Create a new Rid by setting the given parameters as query part of this Rid.
|
List |
split()
Splits the Rid into its path components
|
String |
toExternalForm()
Convert this Rid to a representation usable in RFC2396 URI references.
|
String toExternalForm()
Note that such an encoded string cannot be used to construct an new Rid object! The path in Rid objects is never, ever encoded.
String getPath()
String getQuery()
Properties getQueryParameter()
Properties
object has no
effect on the Rid itself.Properties
IRid root()
The root Rid of a toplevel collection is the root collection Rid. The root Rid of the root Rid is the root Rid itself.
IRid name()
IRid parent()
String extension()
IRid removeRoot()
IRid removeName()
IRid removeExtension()
IRid removeTrailingSlash()
boolean isAbsolute()
boolean isRoot()
boolean isAncestorOf(IRid child)
child
- to test againstboolean isAncestorOfOrSelf(IRid child)
child
- to test againstboolean endsWithSlash()
IRid add(String uri)
uri
- to append to thisIRid add(IRid uri)
uri
- to append to thisint length()
IRid resolveRelativeRid(String uri)
uri
- An Rid, which may be relative or absoluteIRid addPathSegment(String segment) throws Exception
segment
- String containing the new path segmentException
- Exception raised in failure situationIRid setQueryParameter(Properties parameter)
parameter
- to set to queryAccess Rights |
---|
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
|
Copyright 2018 SAP AG Complete Copyright Notice