qdml QJML Schema


SCHEMA TREEINDEX


text: ID

attribute of: abstract access accessClass attributes bean coin contentModel elements enum excludes extends field id identity ignore implements interface item link property qdml range rem selection sequence text

Identifies the element.

text: PUBLIC

attribute of: qdml

The PUBLIC identifier. (A URI naming the type of document.)

text: SYSTEM

attribute of: qdml

The SYSTEM identifier. (The URL of the DTD.)

bean: abstract

extends coin
implements element
implements data
targetClass: com.jxml.quick.model.qjml.QMAbstract

Abstract elements are used to define attributes for more than one type of coin. Abstract elements can implement any number of interface elements. An abstract coin can extend one other abstract coin.

Attributes (the attributes are not inherited)


Children

full tree

abstract: access

child of: item selection sequence
targetClass: com.jxml.quick.model.qjml.QMAccess

Defines the means by which a data item is accessed.

Attributes (the attributes are not inherited)


Other fields/properties


Is extended/implemented by



bean: accessClass

extends access
targetClass: com.jxml.quick.model.qjml.QMAccessClass

The full name of the class used to access the data item.

Attributes (the attributes are not inherited)



text: accessor

attribute of: accessClass

Full name of a class which implements com.jxml.quick.access.QAccess.

bean: attributes

child of: abstract bean
targetClass: com.jxml.quick.model.qjml.QMAttributes

Holds the pieces which define the attributes of the element.

Attributes (the attributes are not inherited)


Children

full tree

abstract: base.type

targetClass: java.lang.Object

Specifies the base data types common to text elements and attribute elements.
will not be generated with QJML2Java

valid values:

Is extended/implemented by



bean: bean

extends coin
implements element
targetClass: com.jxml.quick.model.qjml.QMBean

bean elements are used to define complex elements with nested element content.

Attributes (the attributes are not inherited)


Children

full tree

text: bean.type (tag=type)

attribute of: bean

Specifies the pre-defined data types for bean elements.

valid values:

abstract: coin

child of: qdml
targetClass: com.jxml.quick.model.qjml.QMCoin

In QDML, a Coin can define an XML element, or an XML attribute. More generally, a Coin defines a type of data element which may take one or more forms, including a Java class or scalar.

Attributes (the attributes are not inherited)


Other fields/properties


Is extended/implemented by



text: coinName (tag=coin)

attribute of: access field identity item link property

A reference to the Coin which defines the data item held by this Coin.

abstract: contentModel

child of: elements selection sequence
targetClass: com.jxml.quick.model.qjml.QMContentModel

A template for elements which define the content model of an element.

Attributes (the attributes are not inherited)


Other fields/properties


Is extended/implemented by



text: cref

attribute of: contentModel item selection sequence

A reference to another content model element.

interface: data

targetClass: com.jxml.quick.model.qjml.QMData

Is extended/implemented by



interface: element

targetClass: com.jxml.quick.model.qjml.QMElement

Is extended/implemented by



bean: elements

child of: bean
targetClass: com.jxml.quick.model.qjml.QMElements

Holds the content model of the a bean coin.

Attributes (the attributes are not inherited)


Children

full tree

bean: enum

implements valid
targetClass: com.jxml.quick.model.qjml.QMEnum

Specifies an acceptable value for an attribute or text coin.

Attributes (the attributes are not inherited)


Children

full tree

bean: excludes

child of: qdml
content: BIMODAL
targetClass: com.jxml.quick.model.qjml.QMExcludes

A coin that is not to be included.

Attributes (the attributes are not inherited)



bean: extends

child of: abstract bean interface text
content: BIMODAL
targetClass: com.jxml.quick.model.qjml.QMExtends

Identifies the coin being extended.

Attributes (the attributes are not inherited)



bean: field

extends access
targetClass: com.jxml.quick.model.qjml.QMField

The data item is a Java variable.

Attributes (the attributes are not inherited)



text: fixed

attribute of: item
content: boolean

The attribute or element will have a fixed text value. When not set to true, the value given will be the default value.

text: generate

attribute of: abstract bean coin interface text
content: boolean

The Java class is to be generated.

bean: id

implements access
targetClass: com.jxml.quick.model.qjml.QMId

The data item is an identifier maintained by QDoc.

Attributes (the attributes are not inherited)



bean: identity

extends access
targetClass: com.jxml.quick.model.qjml.QMIdentity

The data item is the entire coin.

Attributes (the attributes are not inherited)



bean: ignore

extends access
targetClass: com.jxml.quick.model.qjml.QMIgnore

The data item is ignored.

Attributes (the attributes are not inherited)



text: imax

attribute of: range

The largest allowed value (inclusive) of a range

text: imin

attribute of: range

The smallest allowed value (inclusive) of a range.

bean: implements

child of: abstract bean text
content: BIMODAL
targetClass: com.jxml.quick.model.qjml.QMImplements

Identifies the interface coin being implemented

Attributes (the attributes are not inherited)



link: include

schema: classpath:///com/jxml/quick/model/qdmlOverQjml.qiml
child of: qdml

A reference to another QDML document whose elements are to be included.

text: inherited

attribute of: attributes field
content: boolean

The attributes inherited from the Coin(s) that this Coin extends or implements.

text: initializer

attribute of: field property

Used to generate the code to initialize a field or property. E.G. new ArrayList()

text: inline

attribute of: bean link text
content: boolean

When false, force the display to a new line. Defaults to true for attributes and false for elements.

bean: interface

extends coin
implements element
targetClass: com.jxml.quick.model.qjml.QMInterface

Interface elements are used to represent more than one type of coin. An interface coin can extend any number of other interfaces.

Attributes (the attributes are not inherited)


Children

full tree

bean: item

extends contentModel
child of: attributes
targetClass: com.jxml.quick.model.qjml.QMItem

An item is used to specify a data item held by a Coin.

Attributes (the attributes are not inherited)


Children

full tree

text: key

attribute of: access field identity property

References an accessor of the content held by this piece. Required for maps. Optional for arrays, indexed properties, and lists

text: kind

attribute of: access field identity property

Identifies the kind of container being used, if other than a scalar.

valid values:

text: label

attribute of: abstract bean coin contentModel interface item link selection sequence text

Specifies a unique identifier.

bean: link

extends coin
implements element
targetClass: com.jxml.quick.model.qjml.QMLink

Link elements are used to define hyperlinks.

Attributes (the attributes are not inherited)


Children

full tree

text: name

attribute of: field property

The name of a public variable or bean property. Also serves as a default label for the field or property.

text: optional

attribute of: contentModel item selection sequence
content: boolean

The data item defined by this content model element is optional when set true.

bean: property

extends access
targetClass: com.jxml.quick.model.qjml.QMProperty

The data item is a Java variable.

Attributes (the attributes are not inherited)



text: property.abstract (tag=abstract)

attribute of: property
content: boolean

Declares a property as abstract. Valid only in an abstract coin.

text: property.inherited (tag=inherited)

attribute of: property

Identifies which property methods are inherited. The value of this attribute is generated by the QJML Model.

valid values:

bean: qdml

targetClass: com.jxml.quick.model.qjml.QMQJML

The qdml element is the root element of the QDML.

Attributes (the attributes are not inherited)


Children

full tree

bean: range

implements valid
targetClass: com.jxml.quick.model.qjml.QMRange

Specifies a range of legal values for an attribute or text coin. Comparison depends on the type of the coin (PCDATA, int, float, etc).

Attributes (the attributes are not inherited)


Children

full tree

text: read

attribute of: property
content: boolean

There is a get method for the property.

bean: rem

child of: abstract bean enum interface item link range selection sequence text
content: BIMODAL
targetClass: com.jxml.quick.model.qjml.QMRem

A comment.

Attributes (the attributes are not inherited)



text: repeating

attribute of: contentModel item selection sequence
content: boolean

The data item defined by this content model element can occur more than once when set true.

text: root

attribute of: qdml

The identifies the root coin.

text: schema

attribute of: item link

Schema for the referenced document.

bean: selection

extends sequence
targetClass: com.jxml.quick.model.qjml.QMSelection

Defines a list of alternative elements.

Attributes (the attributes are not inherited)


Children

full tree

bean: sequence

extends contentModel
targetClass: com.jxml.quick.model.qjml.QMSequence

Defines a fixed sequence of elements.

Attributes (the attributes are not inherited)


Children

full tree

Is extended/implemented by



text: size

attribute of: access field identity property
content: int

The size of an array or indexed property.

text: tag

attribute of: bean link text

An XML attribute or element tag name.

bean: text

extends coin
implements element
implements data
targetClass: com.jxml.quick.model.qjml.QMText

Text elements are used to define attributes and simple elements with text content.

Attributes (the attributes are not inherited)


Children

full tree

text: text.type (tag=type)

extends base.type
attribute of: text

Specifies the pre-defined data types for text elements.

valid values:

text: trim

attribute of: text
content: boolean

Remove leading/trailing whitespace.

interface: valid

child of: abstract text
targetClass: com.jxml.quick.model.qjml.QMValid

Specifies the legal values of an attribute or text coin.

Is extended/implemented by



text: validInherited

attribute of: abstract text
content: boolean

Indicates that enums and ranges are inherited.

text: value

attribute of: enum item

An attribute or text value.

text: wild

attribute of: bean link text
content: boolean

Defines a "wild card" Coin which can be used with any XML attribute or element. When true, label must be set, but not tag.

text: write

attribute of: property
content: boolean

There is a set method for the property.

text: xmax

attribute of: range

The largest allowed value (exclusive) of a range

text: xmin

attribute of: range

The smallest allowed value (exclusive) of a range.

SCHEMA TREE

qdml
|---include


INDEX

abstract
access
accessClass
accessor
attributes
base.type
bean
bean.type (tag=type)
coin
coinName (tag=coin)
contentModel
cref
data
element
elements
enum
excludes
extends
field
fixed
generate
id
ID
identity
ignore
imax
imin
implements
include
inherited
initializer
inline
interface
item
key
kind
label
link
name
optional
property
property.abstract (tag=abstract)
property.inherited (tag=inherited)
PUBLIC
qdml
range
read
rem
repeating
root
schema
selection
sequence
size
SYSTEM
tag
text
text.type (tag=type)
trim
valid
validInherited
value
wild
write
xmax
xmin