xmlBlaster 2.1.0 API

org.xmlBlaster.client.key
Class GetKey

java.lang.Object
  extended by org.xmlBlaster.client.key.GetKey

public class GetKey
extends java.lang.Object

Wraps an XML key for a get() invocation.

See QueryKeySaxFactory for a syntax description of the allowed xml structure

See Also:
QueryKeySaxFactory, the interface.get requirement

Field Summary
private static java.lang.String ME
           
private  QueryKeyData queryKeyData
           
 
Constructor Summary
GetKey(Global glob, QueryKeyData queryKeyData)
          Constructor for internal use.
GetKey(Global glob, java.lang.String query)
          Create a key data holder to access message(s).
GetKey(Global glob, java.lang.String queryString, java.lang.String queryType)
          Constructor for XPath query.
 
Method Summary
 QueryKeyData getData()
           
 java.lang.String getDomain()
          Access the domain setting
 java.lang.String getOid()
          Access the <key oid="...">.
 java.lang.String getQueryString()
           
 java.lang.String getQueryType()
          Access the query type "XPATH" or "EXACT"
 void setDomain(java.lang.String domain)
          Give a hint to which cluster domain this Key belongs.
 void setOid(java.lang.String oid)
          Set the $lt;key oid="...">.
 void setQueryString(java.lang.String tags)
          Your XPath query string.
 java.lang.String toString()
          Converts the data in XML ASCII string.
 java.lang.String toXml()
          Converts the data in XML ASCII string.
 java.lang.String wrap(java.lang.String str)
          May be used to integrate your application tags.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ME

private static final java.lang.String ME
See Also:
Constant Field Values

queryKeyData

private final QueryKeyData queryKeyData
Constructor Detail

GetKey

public GetKey(Global glob,
              java.lang.String query)
Create a key data holder to access message(s).

Parameters:
query - The query string For example a topic oid like "Hello" or "oid:Hello" or a query like "xpath://key", "domain:CLUSTER")

GetKey

public GetKey(Global glob,
              java.lang.String queryString,
              java.lang.String queryType)
       throws XmlBlasterException
Constructor for XPath query.

Parameters:
queryString - The String with e.g. XPath syntax
queryType - The query syntax, e.g. Constants.XPATH
XmlBlasterException - for invalid queryType
Throws:
XmlBlasterException

GetKey

public GetKey(Global glob,
              QueryKeyData queryKeyData)
Constructor for internal use.

Parameters:
queryKeyData - The struct holding the data
Method Detail

getData

public QueryKeyData getData()

setOid

public final void setOid(java.lang.String oid)
Set the $lt;key oid="...">.

Parameters:
The - unique key oid

getOid

public final java.lang.String getOid()
Access the <key oid="...">.

Returns:
The unique key oid

getQueryType

public java.lang.String getQueryType()
Access the query type "XPATH" or "EXACT"

Returns:
A queryType string or null

setQueryString

public void setQueryString(java.lang.String tags)
Your XPath query string.

Parameters:
str - Your tags in ASCII XML syntax

getQueryString

public java.lang.String getQueryString()

setDomain

public void setDomain(java.lang.String domain)
Give a hint to which cluster domain this Key belongs.


getDomain

public java.lang.String getDomain()
Access the domain setting

Returns:
A domain string or null

toString

public java.lang.String toString()
Converts the data in XML ASCII string.

Overrides:
toString in class java.lang.Object
Returns:
An XML ASCII string

toXml

public java.lang.String toXml()
Converts the data in XML ASCII string.

Returns:
An XML ASCII string

wrap

public java.lang.String wrap(java.lang.String str)
May be used to integrate your application tags.

Parameters:
str - Your tags
Returns:
The ASCII XML key containing the key tag and your tags

xmlBlaster 2.1.0 API

Copyright © 1999-2011 The xmlBlaster.org contributers.