org.xmlBlaster.client.key
Class SubscribeKey

java.lang.Object
  org.xmlBlaster.client.key.SubscribeKey

public class SubscribeKey

extends java.lang.Object

Wrap the XML key for a subscribe() invocation.

See QueryKeySaxFactory for a syntax description of the allowed xml structure

See Also:

QueryKeySaxFactory, the interface.subscribe requirement, TestSubMultiSubscribe

Field Summary

private static java.lang.String	ME
private QueryKeyData	queryKeyData

Constructor Summary

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

SubscribeKey(Global glob, java.lang.String query)
Constructor with given oid or url.

SubscribeKey(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 <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

SubscribeKey

public SubscribeKey(Global glob,
                    java.lang.String query)

Constructor with given oid or url.

Parameters:

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

SubscribeKey

public SubscribeKey(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

SubscribeKey

public SubscribeKey(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 <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.

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.

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