org.fabric3.spi.introspection.xml

Interface LoaderHelper

public interface LoaderHelper

Helper service for handling XML.

Method Summary

Modifier and Type	Method and Description
boolean	canNarrow(org.fabric3.api.model.type.component.Multiplicity first, org.fabric3.api.model.type.component.Multiplicity second) Determines if the first multiplicity setting can narrow the second.
javax.xml.namespace.QName	createQName(java.lang.String name, javax.xml.stream.XMLStreamReader reader) Constructs a QName from the given name.
java.lang.String	loadKey(javax.xml.stream.XMLStreamReader reader) Load the value of the attribute key from the current element.
org.w3c.dom.Document	loadPropertyValue(java.lang.String content) Loads a property value configured in a composite or on a component using the @value attribute from a String.
org.w3c.dom.Document	loadPropertyValues(javax.xml.stream.XMLStreamReader reader) Loads one or more property values configured in a composite or on a component from a Stax stream.
org.fabric3.api.model.type.component.Target	parseTarget(java.lang.String target, javax.xml.stream.XMLStreamReader reader) Convert a URI from a String form of component/service/binding to a Target.
org.w3c.dom.Document	transform(javax.xml.stream.XMLStreamReader reader) Transforms the XML element to a DOM representation.

Method Detail

loadKey

java.lang.String loadKey(javax.xml.stream.XMLStreamReader reader)

Load the value of the attribute key from the current element.

Parameters:

reader - a stream containing a property value

Returns:

the key value

loadPropertyValues

org.w3c.dom.Document loadPropertyValues(javax.xml.stream.XMLStreamReader reader)
                                 throws javax.xml.stream.XMLStreamException

Loads one or more property values configured in a composite or on a component from a Stax stream. Each property value is returned as child of the document root. The reader must be positioned at the composite or component <property> element.

Parameters:

reader - the stream reader

Returns:

a document containing the values

Throws:

javax.xml.stream.XMLStreamException - if there was a problem reading the stream

loadPropertyValue

org.w3c.dom.Document loadPropertyValue(java.lang.String content)
                                throws javax.xml.stream.XMLStreamException

Loads a property value configured in a composite or on a component using the @value attribute from a String.

Parameters:

content - String content

Returns:

a document containing the values

Throws:

javax.xml.stream.XMLStreamException - if there was a problem reading the stream

parseTarget

org.fabric3.api.model.type.component.Target parseTarget(java.lang.String target,
                                                        javax.xml.stream.XMLStreamReader reader)
                                                 throws InvalidTargetException

Convert a URI from a String form of component/service/binding to a Target.

Parameters:

target - the URI to convert

reader - the stream reader parsing the XML document where the target is specified

Returns:

a target instance

Throws:

InvalidTargetException - if the target format is invalid

createQName

javax.xml.namespace.QName createQName(java.lang.String name,
                                      javax.xml.stream.XMLStreamReader reader)
                               throws InvalidPrefixException

Constructs a QName from the given name. If a namespace prefix is not specified in the name, the namespace context is used.

Parameters:

name - the name to parse

reader - the XML stream reader

Returns:

the parsed QName

Throws:

InvalidPrefixException - if a specified namespace prefix is invalid

canNarrow

boolean canNarrow(org.fabric3.api.model.type.component.Multiplicity first,
                  org.fabric3.api.model.type.component.Multiplicity second)

Determines if the first multiplicity setting can narrow the second.

Parameters:

first - multiplicity setting

second - multiplicity setting

Returns:

true if the first can narrow the second

transform

org.w3c.dom.Document transform(javax.xml.stream.XMLStreamReader reader)
                        throws javax.xml.stream.XMLStreamException

Transforms the XML element to a DOM representation.

Parameters:

reader - the XML stream reader

Returns:

the DOM

Throws:

javax.xml.stream.XMLStreamException - if a conversion exception is encountered