|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.xcap.DocumentSelector
public class DocumentSelector
The DocumentSelector is a class which represents the document selector portion of the XCAP URI.
Field Summary | |
---|---|
static java.lang.String |
TYPE_ATTRIBUTE
|
static java.lang.String |
TYPE_DIRECTORY
|
static java.lang.String |
TYPE_DOCUMENT
|
static java.lang.String |
TYPE_ELEMENT
|
Constructor Summary | |
---|---|
DocumentSelector(java.lang.String xcapURI)
Finds and constructs the document selector based on the original XCAP URI |
|
DocumentSelector(java.lang.String xcapURI,
boolean doNormalizeUID)
Finds and constructs the document selector based on the original XCAP URI |
|
DocumentSelector(java.lang.String xcapURI,
java.lang.String defaultNamespace)
Finds and constructs the document selector based on the original XCAP URI |
|
DocumentSelector(java.lang.String xcapURI,
java.lang.String defaultNamespace,
boolean doNormalizeUID)
Finds and constructs the document selector based on the original XCAP URI |
|
DocumentSelector(java.lang.String auid,
java.lang.String xui,
java.lang.String documentName)
Constructs the document selector from parameters |
|
DocumentSelector(java.lang.String auid,
java.lang.String xui,
java.lang.String documentName,
boolean doNormalizeUID)
Constructs the document selector from parameters |
Method Summary | |
---|---|
int |
compareTo(DocumentSelector aDocumentSelector)
Compares this DocumentSelector to another DocumentSelector. |
boolean |
equals(java.lang.Object o)
|
static java.lang.String |
extractAuid(java.lang.String xcapURI)
Extracts the AUID from an XCAP URI |
java.lang.String |
getAuid()
Returns the AUID |
java.lang.String |
getDocumentName()
Returns the document name. |
NodeSelector |
getNodeSelector()
Returns the NodeSelector if constructed with the XCAP URI. |
java.lang.String |
getType()
Returns the type of the document selector. |
java.lang.String |
getXcapRoot()
Returns the XcapRoot if constructed with the XCAP URI. |
java.lang.String |
getXui()
Returns the XUI of the document selector. |
int |
hashCode()
|
boolean |
isGlobalDocument()
Returns whether the document selector references a global document |
DocumentSelector |
substituteAuid(java.lang.String auid)
Returns a DocumentSelector with the AUID substituted with the specified parameter. |
DocumentSelector |
substituteDocumentName(java.lang.String documentName)
Returns a DocumentSelector with the document name substituted with the specified parameter. |
java.lang.String |
toString()
|
java.lang.String |
toStringAll()
Returns full documentSelector with xcap root |
java.lang.String |
toStringWithNodeSelector()
Returns the DocumentSelector String including the NodeSelector portion |
protected java.lang.String |
trim(java.lang.String segment)
Trims white spaces and slashes |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String TYPE_DIRECTORY
public static final java.lang.String TYPE_DOCUMENT
public static final java.lang.String TYPE_ELEMENT
public static final java.lang.String TYPE_ATTRIBUTE
Constructor Detail |
---|
public DocumentSelector(java.lang.String auid, java.lang.String xui, java.lang.String documentName)
auid
- The AUID.xui
- The XUI if under the users tree.documentName
- The document name.public DocumentSelector(java.lang.String auid, java.lang.String xui, java.lang.String documentName, boolean doNormalizeUID)
auid
- The AUID.xui
- The XUI if under the users tree.documentName
- The document name.doNormalizeUID
- Normalize the XUI based on the normalization
configuration settingspublic DocumentSelector(java.lang.String xcapURI) throws java.net.MalformedURLException
xcapURI
-
java.net.MalformedURLException
public DocumentSelector(java.lang.String xcapURI, java.lang.String defaultNamespace) throws java.net.MalformedURLException
xcapURI
- defaultNamespace
-
java.net.MalformedURLException
public DocumentSelector(java.lang.String xcapURI, boolean doNormalizeUID) throws java.net.MalformedURLException
xcapURI
- doNormalizeUID
- Normalize the XUI based on the normalization
configuration settings
java.net.MalformedURLException
public DocumentSelector(java.lang.String xcapURI, java.lang.String defaultNamespace, boolean doNormalizeUID) throws java.net.MalformedURLException
xcapURI
- defaultNamespace
- doNormalizeUID
- Normalize the XUI based on the normalization
configuration settings
java.net.MalformedURLException
Method Detail |
---|
protected java.lang.String trim(java.lang.String segment)
segment
- A segment
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toStringWithNodeSelector()
public java.lang.String toStringAll()
public java.lang.String getAuid()
public java.lang.String getDocumentName()
public NodeSelector getNodeSelector()
public java.lang.String getXcapRoot()
public java.lang.String getXui()
public java.lang.String getType()
public boolean isGlobalDocument()
public DocumentSelector substituteAuid(java.lang.String auid)
auid
- The AUID used for substitution.
public DocumentSelector substituteDocumentName(java.lang.String documentName)
documentName
- The document name used for substitution.
public static java.lang.String extractAuid(java.lang.String xcapURI) throws java.net.MalformedURLException
xcapURI
- XCAP URI
java.net.MalformedURLException
- If the AUID was not foundpublic boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public int compareTo(DocumentSelector aDocumentSelector)
aDocumentSelector
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |