Package org.apache.ws.commons.schema.utils

Interface XmlSchemaNamedWithForm

All Superinterfaces:

XmlSchemaNamed, XmlSchemaObjectBase

All Known Implementing Classes:

XmlSchemaAttribute, XmlSchemaElement, XmlSchemaNamedWithFormImpl

public interface XmlSchemaNamedWithForm
extends XmlSchemaNamed

Attributes and elements have names that are influenced by their form. Essentially, the 'form' has three possible values: qualified, unqualified, and 'inherit from parent' (= unspecified).

Method Summary

Modifier and Type	Method	Description
XmlSchemaForm	getForm()	Get the current form, which may be inherited from the parent schema.
QName	getWireName()	The name of this item as it is sent 'over the wire' or stored in an XML file.
boolean	isFormSpecified()	True if this item has a specified form, false if it inherits from the parent schema.
void	setForm(XmlSchemaForm form)	Set the schema form.

Methods inherited from interface org.apache.ws.commons.schema.utils.XmlSchemaNamed

getName, getParent, getQName, isAnonymous, isTopLevel, setName

Method Details

getForm

XmlSchemaForm getForm()

Get the current form, which may be inherited from the parent schema. This will never return XmlSchemaForm.NONE.

Returns:

setForm

void setForm(XmlSchemaForm form)

Set the schema form.

Parameters:

form - Schema form. Pass in XmlSchemaForm.NONE to inherit from the parent schema.

isFormSpecified

boolean isFormSpecified()

True if this item has a specified form, false if it inherits from the parent schema.

Returns:

getWireName

QName getWireName()

The name of this item as it is sent 'over the wire' or stored in an XML file. If the form is unqualified, this has "" for a namespaceURI. Otherwise, it is the same as getQName().

Returns: