org.apache.woden.internal.wsdl20

Class InterfaceImpl

java.lang.Object

org.apache.woden.internal.wsdl20.WSDLElementImpl

org.apache.woden.internal.wsdl20.DocumentableImpl

org.apache.woden.internal.wsdl20.WSDLComponentImpl

org.apache.woden.internal.wsdl20.InterfaceImpl

All Implemented Interfaces:

AttributeExtensible, ElementExtensible, PropertyExtensible, Interface, WSDLComponent, DocumentableElement, InterfaceElement, NestedElement, WSDLElement

public class InterfaceImpl
extends WSDLComponentImpl
implements Interface, InterfaceElement

This class represents the Interface component from the WSDL 2.0 Component Model and <interface> element.

Author:

jkaputin@apache.org

Constructor Summary

Constructors

Constructor and Description
InterfaceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtendedInterfaceName(QName interfaceName) Add the named InterfaceElement to the set of InterfaceElements that this InterfaceElement extends.
InterfaceFaultElement	addInterfaceFaultElement() Create an InterfaceFaultElement with this InterfaceElement as its parent and return a reference to it.
InterfaceOperationElement	addInterfaceOperationElement() Create an InterfaceOperationElement with this InterfaceElement as its parent and return a reference to it.
void	addStyleDefaultURI(URI uri) Add the specified URI to the set of default operation style URIs.
boolean	equals(WSDLComponent comp) Tests whether this component is logically equivalent the specified component.
InterfaceFault[]	getAllInterfaceFaults() Returns the set of all InterfaceFault components available to this Interface, which includes those declared by this Interface and those defined by any Interfaces it extends, directly or indirectly.
InterfaceOperation[]	getAllInterfaceOperations() Returns the set of all InterfaceOperation components available to this Interface, which includes those declared by this Interface and those defined by the Interfaces it extends, directly or indirectly.
Interface	getExtendedInterface(QName qname) Return the named Interface from the {extended interfaces} property of this Interface.
InterfaceElement	getExtendedInterfaceElement(QName interfaceName) Return the named InterfaceElement from the set of IntefaceElements extended by this InterfaceElement.
InterfaceElement[]	getExtendedInterfaceElements() Return the set of InterfaceElements extended by this InterfaceElement.
QName[]	getExtendedInterfaceNames() Return the qualified names of the InterfaceElements that this InterfaceElement extends.
Interface[]	getExtendedInterfaces() Represents the {extended interfaces} property of the Interface component.
FragmentIdentifier	getFragmentIdentifier() Returns the fragment identifier for this WSDL 2.0 component.
InterfaceFault	getFromAllInterfaceFaults(QName faultName) Returns the InterfaceFault with the specified name from the set of all InterfaceFaults available to this Interface, which includes those declared by this Interface and those defined by any Interfaces it extends, directly or indirectly.
InterfaceOperation	getFromAllInterfaceOperations(QName operName) Returns the InterfaceOperation with the specified name from the set of all InterfaceOperations available to this Interface, which includes those declared by this Interface and those defined by any Interfaces it extends, directly or indirectly.
InterfaceFault	getInterfaceFault(QName faultName) Returns the InterfaceFault with the specified name from the {interface faults} property of this Interface.
InterfaceFaultElement	getInterfaceFaultElement(QName faultName) Return the named InterfaceFaultElement from the set of InterfaceFaultElements defined directly within this InterfaceElement.
InterfaceFaultElement[]	getInterfaceFaultElements() Return the set of InterfaceFaultElements defined directly within this InterfaceElement.
InterfaceFault[]	getInterfaceFaults() Represents the {interface faults} property of the Interface component.
InterfaceOperation	getInterfaceOperation(QName operName) Returns the InterfaceOperation with the specified name from the {interface operations} property of this Interface.
InterfaceOperationElement	getInterfaceOperationElement(QName operName) Return the named InterfaceOperationElement from the set of InterfaceOperationElements defined directly within this InterfaceElement.
InterfaceOperationElement[]	getInterfaceOperationElements() Return the set of InterfaceOperationElements defined directly within this InterfaceElement.
InterfaceOperation[]	getInterfaceOperations() Represents the {interface operations} property of the Interface component.
QName	getName() Returns the qualified name representing the {name} property of this Interface.
WSDLElement	getParentElement()
URI[]	getStyleDefault() Return the set of URIs representing the default operation style.
boolean	isEquivalentTo(WSDLComponent comp) Tests whether this component is logically equivalent the specified component.
void	removeExtendedInterfaceName(QName interfaceName) Remove the named InterfaceElement from the set of InterfaceElements that this InterfaceElement extends.
void	setName(NCName name) Set the name of this InterfaceElement to the specified NCName.
InterfaceElement	toElement() Returns a WSDLElement that represents the element information item from the WSDL 2.0 infoset that maps to this WSDLComponent.

Methods inherited from class org.apache.woden.internal.wsdl20.WSDLComponentImpl

containsComponent, getComponentExtensionContext, getExtensionProperties, getExtensionProperties, getExtensionProperty, setComponentExtensionContext, toString

Methods inherited from class org.apache.woden.internal.wsdl20.DocumentableImpl

addDocumentationElement, getDocumentationElements

Methods inherited from class org.apache.woden.internal.wsdl20.WSDLElementImpl

addExtensionElement, addNamespace, getDeclaredNamespaces, getExtensionAttribute, getExtensionAttributes, getExtensionAttributesForNamespace, getExtensionElements, getExtensionElementsOfType, getInScopeNamespaces, getNamespacePrefix, getNamespaceURI, hasExtensionAttributesForNamespace, hasExtensionElementsForNamespace, removeExtensionElement, removeNamespace, setExtensionAttribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.woden.wsdl20.WSDLComponent

getComponentExtensionContext, setComponentExtensionContext, toString

Methods inherited from interface org.apache.woden.wsdl20.extensions.PropertyExtensible

getExtensionProperties, getExtensionProperties, getExtensionProperty

Methods inherited from interface org.apache.woden.wsdl20.xml.DocumentableElement

addDocumentationElement, getDocumentationElements

Methods inherited from interface org.apache.woden.wsdl20.xml.WSDLElement

addNamespace, getDeclaredNamespaces, getInScopeNamespaces, getNamespacePrefix, getNamespaceURI, removeNamespace

Methods inherited from interface org.apache.woden.wsdl20.extensions.AttributeExtensible

getExtensionAttribute, getExtensionAttributes, getExtensionAttributesForNamespace, hasExtensionAttributesForNamespace, setExtensionAttribute

Methods inherited from interface org.apache.woden.wsdl20.extensions.ElementExtensible

addExtensionElement, getExtensionElements, getExtensionElementsOfType, hasExtensionElementsForNamespace, removeExtensionElement

Constructor Detail

InterfaceImpl

public InterfaceImpl()

Method Detail

getName

public QName getName()

Description copied from interface: Interface

Returns the qualified name representing the {name} property of this Interface.

Specified by:

getName in interface Interface

Specified by:

getName in interface InterfaceElement

Returns:

QName representing the name of this Interface

getExtendedInterface

public Interface getExtendedInterface(QName qname)

Description copied from interface: Interface

Return the named Interface from the {extended interfaces} property of this Interface. That is, from the set of declared Interfaces that this Interface directly extends. If null is specified for the name, this method will return null.

Specified by:

getExtendedInterface in interface Interface

Parameters:

qname - the qualified name of the required Interface

Returns:

the named Interface

getExtendedInterfaces

public Interface[] getExtendedInterfaces()

Description copied from interface: Interface

Represents the {extended interfaces} property of the Interface component. This is the set of declared Interface components that this Interface directly extends, but does not include any Interfaces that those Interfaces extend. The method will return an empty array if there are no extended interfaces.

Specified by:

getExtendedInterfaces in interface Interface

Returns:

an array of Interface components

getInterfaceFaults

public InterfaceFault[] getInterfaceFaults()

Description copied from interface: Interface

Represents the {interface faults} property of the Interface component. This is the set of interface faults declared directly by this interface, but not those defined by any interfaces that this interface extends. The method will return an empty array if there are no interface faults.

Specified by:

getInterfaceFaults in interface Interface

Returns:

array of InterfaceFault components

getInterfaceFault

public InterfaceFault getInterfaceFault(QName faultName)

Description copied from interface: Interface

Returns the InterfaceFault with the specified name from the {interface faults} property of this Interface. That is, from the set of InterfaceFaults declared directly by this Interface and excluding any inherited directly or indirectly from extended Interfaces. If the name parameter is null, this method will return null.

Specified by:

getInterfaceFault in interface Interface

Parameters:

faultName - the qualified name of the InterfaceFault

Returns:

the InterfaceFault object

getAllInterfaceFaults

public InterfaceFault[] getAllInterfaceFaults()

Description copied from interface: Interface

Returns the set of all InterfaceFault components available to this Interface, which includes those declared by this Interface and those defined by any Interfaces it extends, directly or indirectly. The method will return an empty array if there are no interface faults.

Specified by:

getAllInterfaceFaults in interface Interface

Returns:

array of InterfaceFault components

getFromAllInterfaceFaults

public InterfaceFault getFromAllInterfaceFaults(QName faultName)

Description copied from interface: Interface

Returns the InterfaceFault with the specified name from the set of all InterfaceFaults available to this Interface, which includes those declared by this Interface and those defined by any Interfaces it extends, directly or indirectly. If the name parameter is null, this method will return null.

Specified by:

getFromAllInterfaceFaults in interface Interface

Parameters:

faultName - the qualified name of the InterfaceFault

Returns:

the InterfaceFault object

getInterfaceOperations

public InterfaceOperation[] getInterfaceOperations()

Description copied from interface: Interface

Represents the {interface operations} property of the Interface component. This is the set of interface operations declared directly by this interface, but not those defined by any interfaces that this interface extends. The method will return an empty array if there are no interface operations.

Specified by:

getInterfaceOperations in interface Interface

Returns:

array of InterfaceOperation components

getInterfaceOperation

public InterfaceOperation getInterfaceOperation(QName operName)

Description copied from interface: Interface

Returns the InterfaceOperation with the specified name from the {interface operations} property of this Interface. That is, from the set of InterfaceOperations declared directly by this Interface and excluding any inherited directly or indirectly from extended Interfaces. If the name parameter is null, this method will return null.

Specified by:

getInterfaceOperation in interface Interface

Parameters:

operName - the qualified name of the required InterfaceOperation

Returns:

the InterfaceOperation object

getAllInterfaceOperations

public InterfaceOperation[] getAllInterfaceOperations()

Description copied from interface: Interface

Returns the set of all InterfaceOperation components available to this Interface, which includes those declared by this Interface and those defined by the Interfaces it extends, directly or indirectly. The method will return an empty array if there are no interface operations.

Specified by:

getAllInterfaceOperations in interface Interface

Returns:

array of InterfaceOperation components

getFromAllInterfaceOperations

public InterfaceOperation getFromAllInterfaceOperations(QName operName)

Description copied from interface: Interface

Returns the InterfaceOperation with the specified name from the set of all InterfaceOperations available to this Interface, which includes those declared by this Interface and those defined by any Interfaces it extends, directly or indirectly. If the name parameter is null, this method will return null.

Specified by:

getFromAllInterfaceOperations in interface Interface

Parameters:

operName - the qualified name of the InterfaceOperation

Returns:

the InterfaceOperation object

toElement

public InterfaceElement toElement()

Description copied from interface: Interface

Returns a WSDLElement that represents the element information item from the WSDL 2.0 infoset that maps to this WSDLComponent.

Specified by:

toElement in interface Interface

Returns:

the InterfaceElement that maps to this Interface

isEquivalentTo

public boolean isEquivalentTo(WSDLComponent comp)

Description copied from interface: WSDLComponent

Tests whether this component is logically equivalent the specified component. Equivalence is determined per spec WSDL 2.0 Part 1 Section 2.17 Equivalence of Components.

Specified by:

isEquivalentTo in interface WSDLComponent

Overrides:

isEquivalentTo in class WSDLComponentImpl

Parameters:

comp - the WSDL component that this component will be compared to

Returns:

true if the components are logically equivalent

equals

public boolean equals(WSDLComponent comp)

Description copied from interface: WSDLComponent

Tests whether this component is logically equivalent the specified component. Equivalence is determined per spec WSDL 2.0 Part 1 Section 2.17 Equivalence of Components.

Specified by:

equals in interface WSDLComponent

Overrides:

equals in class WSDLComponentImpl

Parameters:

comp - the WSDL component that this component will be compared to

Returns:

true if the components are logically equivalent

See Also:

WSDLComponent.isEquivalentTo(WSDLComponent)

setName

public void setName(NCName name)

Description copied from interface: InterfaceElement

Set the name of this InterfaceElement to the specified NCName. This corresponds to the name attribute of the <interface> element.

Specified by:

setName in interface InterfaceElement

Parameters:

name - the NCName that represents the local name of this interface

addStyleDefaultURI

public void addStyleDefaultURI(URI uri)

Description copied from interface: InterfaceElement

Add the specified URI to the set of default operation style URIs. This equates to adding a URI to the styleDefault attribute of the <interface> element. If a null style URI is specified, no action is performed.

Specified by:

addStyleDefaultURI in interface InterfaceElement

Parameters:

uri - a URI representing an operation style

getStyleDefault

public URI[] getStyleDefault()

Description copied from interface: InterfaceElement

Return the set of URIs representing the default operation style. This equates to the URIs defined in the styleDefault attribute of the <interface> element. If no style default URIs exist, an empty array is returned.

Specified by:

getStyleDefault in interface InterfaceElement

Returns:

an array of URI representing the default operation style

addExtendedInterfaceName

public void addExtendedInterfaceName(QName interfaceName)

Description copied from interface: InterfaceElement

Add the named InterfaceElement to the set of InterfaceElements that this InterfaceElement extends. This equates to adding a QName to the extends attribute of the <interface> element. If a null interface name is specified, no action is performed.

Specified by:

addExtendedInterfaceName in interface InterfaceElement

Parameters:

interfaceName - the QName of an extended interface

removeExtendedInterfaceName

public void removeExtendedInterfaceName(QName interfaceName)

Description copied from interface: InterfaceElement

Remove the named InterfaceElement from the set of InterfaceElements that this InterfaceElement extends. This equates to removing a QName from the extends attribute of the <interface> element. If the named InterfaceElement is not extended by this InterfaceElement or if a null interface name is specified, no action is performed.

Specified by:

removeExtendedInterfaceName in interface InterfaceElement

Parameters:

interfaceName - the QName of an extended interface

getExtendedInterfaceNames

public QName[] getExtendedInterfaceNames()

Description copied from interface: InterfaceElement

Return the qualified names of the InterfaceElements that this InterfaceElement extends. This equates to the set of QNames defined in the extends attribute of the <interface> element. If no extended interfaces exist, an empty array is returned.

Specified by:

getExtendedInterfaceNames in interface InterfaceElement

Returns:

an array of QName

getExtendedInterfaceElement

public InterfaceElement getExtendedInterfaceElement(QName interfaceName)

Description copied from interface: InterfaceElement

Return the named InterfaceElement from the set of IntefaceElements extended by this InterfaceElement. The specified QName should equate to a QName defined in the extends attribute of the <interface> element. If the named InterfaceElement is not extended by this InterfaceElement or if a null interface name is specified, this method will return null.

Specified by:

getExtendedInterfaceElement in interface InterfaceElement

Parameters:

interfaceName - the QName of an extended interface

Returns:

the named InterfaceElement

getExtendedInterfaceElements

public InterfaceElement[] getExtendedInterfaceElements()

Description copied from interface: InterfaceElement

Return the set of InterfaceElements extended by this InterfaceElement. This equates to the set of QNames defined in the extends attribute of the <interface> element. If no extended interfaces exist, an empty array is returned.

Specified by:

getExtendedInterfaceElements in interface InterfaceElement

Returns:

an array of InterfaceElement

addInterfaceFaultElement

public InterfaceFaultElement addInterfaceFaultElement()

Description copied from interface: InterfaceElement

Create an InterfaceFaultElement with this InterfaceElement as its parent and return a reference to it. This equates to adding a <fault> element to the <interface> element.

Specified by:

addInterfaceFaultElement in interface InterfaceElement

Returns:

the InterfaceFaultElement

getInterfaceFaultElement

public InterfaceFaultElement getInterfaceFaultElement(QName faultName)

Description copied from interface: InterfaceElement

Return the named InterfaceFaultElement from the set of InterfaceFaultElements defined directly within this InterfaceElement. This equates to a named <fault> element declared within the <interface> element. This set does not include faults derived from extended interfaces. If the named InterfaceFaultElement does not exist or if a null value is specified, this method will return null.

Specified by:

getInterfaceFaultElement in interface InterfaceElement

Parameters:

faultName - the QName of the required InterfaceFaultElement

Returns:

the named InterfaceFaultElement

getInterfaceFaultElements

public InterfaceFaultElement[] getInterfaceFaultElements()

Description copied from interface: InterfaceElement

Return the set of InterfaceFaultElements defined directly within this InterfaceElement. This equates to the set of <fault> elements declared within this <interface> element. This set does not include faults derived from extended interfaces. If no InterfaceFaultElements exist, an empty array is returned.

Specified by:

getInterfaceFaultElements in interface InterfaceElement

Returns:

array of InterfaceFaultElement

addInterfaceOperationElement

public InterfaceOperationElement addInterfaceOperationElement()

Description copied from interface: InterfaceElement

Create an InterfaceOperationElement with this InterfaceElement as its parent and return a reference to it. This equates to adding an <operation> element to the <interface> element. If no InterfaceOperationElements exist, an empty array is returned.

Specified by:

addInterfaceOperationElement in interface InterfaceElement

Returns:

the InterfaceOperationElement

getInterfaceOperationElement

public InterfaceOperationElement getInterfaceOperationElement(QName operName)

Description copied from interface: InterfaceElement

Return the named InterfaceOperationElement from the set of InterfaceOperationElements defined directly within this InterfaceElement. This equates to a named <operation> element declared within the <interface> element. This set does not include operations derived from extended interfaces. If the named InterfaceOperationElement does not exist or if a null value is specified, this method will return null.

Specified by:

getInterfaceOperationElement in interface InterfaceElement

Parameters:

operName - the QName of the required InterfaceOperationElement

Returns:

the named InterfaceOperationElement

getInterfaceOperationElements

public InterfaceOperationElement[] getInterfaceOperationElements()

Description copied from interface: InterfaceElement

Return the set of InterfaceOperationElements defined directly within this InterfaceElement. This equates to the set of <operation> elements declared within this <interface> element. This set does not include operations derived from extended interfaces. If no InterfaceOperationElements exist, an empty array is returned.

Specified by:

getInterfaceOperationElements in interface InterfaceElement

Returns:

array of InterfaceOperationElement

getParentElement

public WSDLElement getParentElement()

Specified by:

getParentElement in interface NestedElement

getFragmentIdentifier

public FragmentIdentifier getFragmentIdentifier()

Description copied from interface: WSDLComponent

Returns the fragment identifier for this WSDL 2.0 component.

Specified by:

getFragmentIdentifier in interface WSDLComponent

Returns:

a FragmentIdentifier for this WSDL 2.0 component.