|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.websphere.sib.wsn.TopicExpression
public class TopicExpression
This class represents the TopicExpressionType type from the WS-Notification Base Notification schema
Field Summary | |
---|---|
protected java.util.Map |
attributes
A map of custom attributes set on the topic expression element. |
static java.net.URI |
CONCRETE_TOPIC_PATH_EXPRESSION
The Dialect value for a concrete topic path expression as defined by WS-Topics |
protected java.net.URI |
dialect
The topic Dialect |
protected javax.xml.soap.SOAPElement |
elementContent
The value of the topic expression content if the value is an element |
static java.net.URI |
FULL_TOPIC_PATH_EXPRESSION
The Dialect value for a fulle topic path expression as defined by WS-Topics |
protected ElementAndText |
mixedContent
The value of the topic expression content if value is mixed text and element |
protected java.util.Map |
prefixNSMappings
A map of prefixes to namespaces for prefixes used in the topic expression. |
static java.net.URI |
SIMPLE_TOPIC_EXPRESSION
The Dialect value for a simple topic expression as defined by WS-Topics |
protected java.lang.String |
topic
The value of the topic expression content if the value is text only |
Constructor Summary | |
---|---|
TopicExpression()
Default constructor. |
|
TopicExpression(java.net.URI dialect,
ElementAndText mixed)
Create a topic expression with a mixed text and single element content value |
|
TopicExpression(java.net.URI dialect,
ElementAndText mixed,
java.util.Map prefixToNamespaceMappings)
Create a topic expression with a mixed text and single element content value |
|
TopicExpression(java.net.URI dialect,
javax.xml.soap.SOAPElement element)
Create a topic expression with a single element content value |
|
TopicExpression(java.net.URI dialect,
javax.xml.soap.SOAPElement element,
java.util.Map prefixToNamespaceMappings)
Create a topic expression with a single element content value |
|
TopicExpression(java.net.URI dialect,
java.lang.String topic)
Create a topic expression with a text only content value |
|
TopicExpression(java.net.URI dialect,
java.lang.String topic,
java.util.Map prefixToNamespaceMappings)
Create a topic expression with a text only content value |
Method Summary | |
---|---|
void |
addAttribute(javax.xml.soap.Name name,
java.lang.String value)
Add a custom attribute to the topic expression |
void |
addPrefixMapping(java.lang.String prefix,
java.lang.String namespace)
Add a mapping between a prefix and a namespace. |
boolean |
equals(java.lang.Object obj)
|
java.util.Iterator |
getAttributes()
Get the names of the custom attributes defined on the topic expression. |
java.lang.String |
getAttributeValue(javax.xml.soap.Name name)
Get the value for a custom attribute. |
java.net.URI |
getDialect()
Get the Dialect value of this topic expression |
java.lang.String |
getNamespaceForPrefix(java.lang.String prefix)
Get the namespace for a given prefix defined for this topic expression |
java.util.Iterator |
getNamespacePrefixes()
Get an iterator over all the prefix values defined in the prefix to namespace map |
java.util.Map |
getNamespacePrefixesMap()
Get the prefix to namespace map |
java.lang.String |
getTopic()
Get the contents of the topic expression as text (String). |
javax.xml.soap.SOAPElement |
getTopicIfElement()
Get the contents of the topic expression as a element. |
ElementAndText |
getTopicIfMixed()
Get the contents of the topic expression as a mixture of text and a single element. |
int |
hashCode()
|
void |
setDialect(java.net.URI uri)
Set the Dialect value of this topic expression. |
void |
setTopic(java.lang.String topic,
java.util.Map prefixToNamespaceMappings)
Set the contents of the topic expression as text. |
void |
setTopicAsElement(javax.xml.soap.SOAPElement element,
java.util.Map prefixToNamespaceMappings)
Set the contents of the topic expression as an element. |
void |
setTopicAsMixed(ElementAndText mixed,
java.util.Map prefixToNamespaceMappings)
Set the contents of the topic expression as a mixture of text and a single element. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.net.URI SIMPLE_TOPIC_EXPRESSION
public static final java.net.URI CONCRETE_TOPIC_PATH_EXPRESSION
public static final java.net.URI FULL_TOPIC_PATH_EXPRESSION
protected java.net.URI dialect
protected java.lang.String topic
protected javax.xml.soap.SOAPElement elementContent
protected ElementAndText mixedContent
protected java.util.Map prefixNSMappings
protected java.util.Map attributes
javax.xml.soap.Name
objects and the values are Strings.
Constructor Detail |
---|
public TopicExpression()
setDialect(URI)
to set
the required Dialect value in order to produce a valid expression.
public TopicExpression(java.net.URI dialect, java.lang.String topic)
dialect
- The topic expression dialect. Three standard values are definedhttp://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple
for simple topic expressionshttp://docs.oasis-open.org/wsn/t-1/TopicExpression/Concrete
for concrete topic path expressionshttp://docs.oasis-open.org/wsn/t-1/TopicExpression/Full
for full topic path expressionstopic
- The contents of the topic expression in a format which is valid for the specified dialectpublic TopicExpression(java.net.URI dialect, java.lang.String topic, java.util.Map prefixToNamespaceMappings)
dialect
- The topic expression dialect. Three standard values are definedhttp://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple
for simple topic expressionshttp://docs.oasis-open.org/wsn/t-1/TopicExpression/Concrete
for concrete topic path expressionshttp://docs.oasis-open.org/wsn/t-1/TopicExpression/Full
for full topic path expressionstopic
- The contents of the topic expression in a format which is valid for the specified dialectprefixToNamespaceMappings
- A String (key) to String (value) map of prefix names to their corresponding namespaces.
Such mappings are required for expressions belonging to one of the three standard dialects. A mapping should be specified for
each prefix used in the topic expression content.public TopicExpression(java.net.URI dialect, javax.xml.soap.SOAPElement element)
dialect
- The topic expression dialect.element
- The contents of the topic expression as a single element.
This format must valid for the specified dialectpublic TopicExpression(java.net.URI dialect, javax.xml.soap.SOAPElement element, java.util.Map prefixToNamespaceMappings)
dialect
- The topic expression dialect.element
- The contents of the topic expression as a single element.
This format must valid for the specified dialectprefixToNamespaceMappings
- (optional) A String (key) to String (value) map of prefix names to their corresponding namespaces.
Mappings need to be specified for each prefix which is used but not declared within the topic expression content.public TopicExpression(java.net.URI dialect, ElementAndText mixed)
dialect
- The topic expression dialect.mixed
- The contents of the topic expression as a mixture of text and a single element.
This format must valid for the specified dialectElementAndText
public TopicExpression(java.net.URI dialect, ElementAndText mixed, java.util.Map prefixToNamespaceMappings)
dialect
- The topic expression dialect.mixed
- The contents of the topic expression as a mixture of text and a single element.
This format must valid for the specified dialectprefixToNamespaceMappings
- (optional) A String (key) to String (value) map of prefix names to their corresponding namespaces.
Mappings need to be specified for each prefix which is used but not declared within the topic expression content.ElementAndText
Method Detail |
---|
public java.net.URI getDialect()
public void setDialect(java.net.URI uri)
uri
- The topic expression dialectpublic java.lang.String getTopic()
public void setTopic(java.lang.String topic, java.util.Map prefixToNamespaceMappings)
topic
- The topic expression contentprefixToNamespaceMappings
- A String (key) to String (value) map of prefix names to their corresponding namespaces.
Mappings need to be specified for each prefix used in the topic expression contentpublic javax.xml.soap.SOAPElement getTopicIfElement()
public void setTopicAsElement(javax.xml.soap.SOAPElement element, java.util.Map prefixToNamespaceMappings)
element
- The topic expression content as a SOAPElementprefixToNamespaceMappings
- (optional) A String (key) to String (value) map of prefix names to
their corresponding namespaces. Mappings need to be specified for each prefix which is used but not
declared within the topic expression content.public ElementAndText getTopicIfMixed()
ElementAndText
public void setTopicAsMixed(ElementAndText mixed, java.util.Map prefixToNamespaceMappings)
mixed
- The topic expression content as a mixture of text and an elementprefixToNamespaceMappings
- (optional) A String (key) to String (value) map of prefix names to
their corresponding namespaces. Mappings need to be specified for each prefix which is used but not
declared within the topic expression content.ElementAndText
public java.util.Iterator getNamespacePrefixes()
public java.util.Map getNamespacePrefixesMap()
public java.lang.String getNamespaceForPrefix(java.lang.String prefix)
prefix
- The prefix for which the namespace is required
public void addPrefixMapping(java.lang.String prefix, java.lang.String namespace)
prefix
- The prefixnamespace
- The namespace corresponding to the prefixpublic void addAttribute(javax.xml.soap.Name name, java.lang.String value) throws java.lang.Exception
name
- The name of the custom attributevalue
- The value of the custom attribute
java.lang.Exception
public java.util.Iterator getAttributes()
public java.lang.String getAttributeValue(javax.xml.soap.Name name)
name
- The name of the custom attribute
public int hashCode()
hashCode
in class java.lang.Object
Object.hashCode()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Object.equals(java.lang.Object)
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |