Schema documentation for cpe-language

Showing:

Annotations

Attributes

Diagrams

Facets

Identity Constraints

Source

Used by

Imported schema cpe-language_2.2a.xsd

Namespace

http://cpe.mitre.org/language/2.0

Annotations

This XML Schema defines the CPE Language. An individual
CPE Name addresses a single part of an actual system. To identify more complex
platform types, there needs to be a way to combine different CPE Names using
logical operators. For example, there may be a need to identify a platform with a
particular operating system AND a certain application. The CPE Language exists to
satisfy this need, enabling the CPE Name for the operating system to be combined
with the CPE Name for the application. For more information, consult the CPE
Specification document.

Element cpe:platform-specification

Namespace

http://cpe.mitre.org/language/2.0

Annotations

This element is the root element of a CPE
Language XML documents and therefore acts as a container for child platform
definitions.

Diagram

Type

cpe:platformSpecificationType

Children

cpe:platform

Source

<xsd:element name="platform-specification" type="cpe:platformSpecificationType">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">This element is the root element of a CPE Language XML documents and therefore acts as a container for child platform definitions.</xsd:documentation>
  </xsd:annotation>
  <xsd:key name="platformKey">
    <xsd:selector xpath="cpe:platform"/>
    <xsd:field xpath="@id"/>
  </xsd:key>
</xsd:element>

Element cpe:platform

Namespace

http://cpe.mitre.org/language/2.0

Diagram

Type

cpe:PlatformType

Type hierarchy

cpe:PlatformBaseType
- cpe:PlatformType

Used by

Complex Type

cpe:platformSpecificationType

Children

cpe:logical-test, cpe:remark, cpe:title

Attributes

QName

Type

Use

Annotation

xsd:anyURI

required

The id attribute holds a locally unique
name for the platform. There is no defined format for this id, it just has
to be unique to the containing language document.

Source

<xsd:element name="platform" type="cpe:PlatformType"/>

Element cpe:PlatformBaseType / cpe:title

Namespace

http://cpe.mitre.org/language/2.0

Annotations

The optional title element may appear as a child
to a platform element. It provides a human-readable title for it. To support
uses intended for multiple languages, this element supports the ‘xml:lang’
attribute. At most one title element can appear for each language.

Diagram

Type

cpe:TextType

Attributes

QName

Type

Use

Annotation

xml:lang

union of(xs:language, restriction of xs:string)

optional

<div>
  <h3>lang (as an attribute name)</h3>
  <p>denotes an attribute whose value is a language code for the natural language of the content of any element; its value is inherited. This name is reserved by virtue of its definition in the XML specification.</p>
</div>
<div>
  <h4>Notes</h4>
  <p>Attempting to install the relevant ISO 2- and 3-letter codes as the enumerated possible values is probably never going to be a realistic possibility.</p>
  <p>See BCP 47 at
    <a href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">http://www.rfc-editor.org/rfc/bcp/bcp47.txt</a>and the IANA language subtag registry at
    <a href="http://www.iana.org/assignments/language-subtag-registry">http://www.iana.org/assignments/language-subtag-registry</a>for further information.</p>
  <p>The union allows for the 'un-declaration' of xml:lang with the empty string.</p>
</div>

Source

<xsd:element name="title" type="cpe:TextType" minOccurs="0" maxOccurs="unbounded">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">The optional title element may appear as a child to a platform element. It provides a human-readable title for it. To support uses intended for multiple languages, this element supports the ‘xml:lang’ attribute. At most one title element can appear for each language.</xsd:documentation>
  </xsd:annotation>
</xsd:element>

Element cpe:PlatformBaseType / cpe:remark

Namespace

http://cpe.mitre.org/language/2.0

Annotations

The optional remark element may appear as a child
of a platform element. It provides some additional description. Zero or more
remark elements may appear. To support uses intended for multiple languages,
this element supports the ‘xml:lang’ attribute. There can be multiple
remarks for a single language.

Diagram

Type

cpe:TextType

Attributes

QName

Type

Use

Annotation

xml:lang

union of(xs:language, restriction of xs:string)

optional

<div>
  <h3>lang (as an attribute name)</h3>
  <p>denotes an attribute whose value is a language code for the natural language of the content of any element; its value is inherited. This name is reserved by virtue of its definition in the XML specification.</p>
</div>
<div>
  <h4>Notes</h4>
  <p>Attempting to install the relevant ISO 2- and 3-letter codes as the enumerated possible values is probably never going to be a realistic possibility.</p>
  <p>See BCP 47 at
    <a href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">http://www.rfc-editor.org/rfc/bcp/bcp47.txt</a>and the IANA language subtag registry at
    <a href="http://www.iana.org/assignments/language-subtag-registry">http://www.iana.org/assignments/language-subtag-registry</a>for further information.</p>
  <p>The union allows for the 'un-declaration' of xml:lang with the empty string.</p>
</div>

Source

<xsd:element name="remark" type="cpe:TextType" minOccurs="0" maxOccurs="unbounded">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">The optional remark element may appear as a child of a platform element. It provides some additional description. Zero or more remark elements may appear. To support uses intended for multiple languages, this element supports the ‘xml:lang’ attribute. There can be multiple remarks for a single language.</xsd:documentation>
  </xsd:annotation>
</xsd:element>

Element cpe:logical-test

Namespace

http://cpe.mitre.org/language/2.0

Diagram

Type

cpe:LogicalTestType

Used by

Complex Types

cpe:PlatformBaseType, cpe:PlatformType

Children

cpe:fact-ref, cpe:logical-test

Attributes

QName	Type	Use
negate	xsd:boolean	required
operator	cpe:operatorEnumeration	required

Source

<xsd:element name="logical-test" type="cpe:LogicalTestType"/>

Element cpe:LogicalTestType / cpe:logical-test

Namespace

http://cpe.mitre.org/language/2.0

Diagram

Type

cpe:LogicalTestType

Children

cpe:fact-ref, cpe:logical-test

Attributes

QName	Type	Use
negate	xsd:boolean	required
operator	cpe:operatorEnumeration	required

Source

<xsd:element name="logical-test" type="cpe:LogicalTestType" minOccurs="0" maxOccurs="unbounded"/>

Element cpe:fact-ref

Namespace

http://cpe.mitre.org/language/2.0

Diagram

Type

cpe:FactRefType

Used by

Complex Type

cpe:LogicalTestType

Attributes

QName	Type	Use
name	cpe:namePattern	required

Source

<xsd:element name="fact-ref" type="cpe:FactRefType"/>

Element cpe:platform-configuration

Namespace

http://cpe.mitre.org/language/2.0

Diagram

Type

cpe:PlatformBaseType

Children

cpe:logical-test, cpe:remark, cpe:title

Source

<xsd:element name="platform-configuration" type="cpe:PlatformBaseType"/>

Simple Type cpe:namePattern

Namespace

http://cpe.mitre.org/language/2.0

Annotations

Define the format for acceptable CPE Names. A URN
      format is used with the id starting with the word cpe followed by :/ and
      then some number of individual components separated by
colons.

Diagram

Type

restriction of xsd:anyURI

Facets

pattern

[c][pP][eE]:/[AHOaho]?(:[A-Za-z0-9\._\-~%]*){0,6}

Used by

Attributes

cpe:FactRefType/@name, prod:FullProductName/@CPE

Source

<xsd:simpleType name="namePattern">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Define the format for acceptable CPE Names. A URN format is used with the id starting with the word cpe followed by :/ and then some number of individual components separated by colons.</xsd:documentation>
  </xsd:annotation>
  <xsd:restriction base="xsd:anyURI">
    <xsd:pattern value="[c][pP][eE]:/[AHOaho]?(:[A-Za-z0-9\._\-~%]*){0,6}"/>
  </xsd:restriction>
</xsd:simpleType>

Complex Type cpe:platformSpecificationType

Namespace

http://cpe.mitre.org/language/2.0

Diagram

Used by

Element

cpe:platform-specification

Children

cpe:platform

Source

<xsd:complexType name="platformSpecificationType">
  <xsd:sequence>
    <xsd:element ref="cpe:platform" minOccurs="1" maxOccurs="unbounded"/>
  </xsd:sequence>
</xsd:complexType>

Complex Type cpe:PlatformType

Namespace

http://cpe.mitre.org/language/2.0

Diagram

Type

extension of cpe:PlatformBaseType

Type hierarchy

cpe:PlatformBaseType
- cpe:PlatformType

Used by

Element

cpe:platform

Children

cpe:logical-test, cpe:remark, cpe:title

Attributes

QName

Type

Use

Annotation

xsd:anyURI

required

The id attribute holds a locally unique
name for the platform. There is no defined format for this id, it just has
to be unique to the containing language document.

Source

<xsd:complexType name="PlatformType">
  <xsd:complexContent>
    <xsd:extension base="cpe:PlatformBaseType">
      <xsd:attribute name="id" type="xsd:anyURI" use="required">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">The id attribute holds a locally unique name for the platform. There is no defined format for this id, it just has to be unique to the containing language document.</xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:extension>
  </xsd:complexContent>
</xsd:complexType>

Complex Type cpe:PlatformBaseType

Namespace

http://cpe.mitre.org/language/2.0

Annotations

The platform element represents the description
or qualifications of a particular IT platform type. The platform is defined
by the logical-test child element.

Diagram

Used by

Complex Type	cpe:PlatformType
Element	cpe:platform-configuration

Children

cpe:logical-test, cpe:remark, cpe:title

Source

<xsd:complexType name="PlatformBaseType">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">The platform element represents the description or qualifications of a particular IT platform type. The platform is defined by the logical-test child element.</xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:element name="title" type="cpe:TextType" minOccurs="0" maxOccurs="unbounded">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">The optional title element may appear as a child to a platform element. It provides a human-readable title for it. To support uses intended for multiple languages, this element supports the ‘xml:lang’ attribute. At most one title element can appear for each language.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="remark" type="cpe:TextType" minOccurs="0" maxOccurs="unbounded">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">The optional remark element may appear as a child of a platform element. It provides some additional description. Zero or more remark elements may appear. To support uses intended for multiple languages, this element supports the ‘xml:lang’ attribute. There can be multiple remarks for a single language.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element ref="cpe:logical-test" minOccurs="1" maxOccurs="1"/>
  </xsd:sequence>
</xsd:complexType>

Complex Type cpe:TextType

Namespace

http://cpe.mitre.org/language/2.0

Annotations

This type allows the xml:lang attribute to
      associate a specific language with an element's string
content.

Diagram

Type

extension of xsd:string

Used by

Elements

cpe:PlatformBaseType/cpe:remark, cpe:PlatformBaseType/cpe:title

Attributes

QName

Type

Use

Annotation

xml:lang

union of(xs:language, restriction of xs:string)

optional

<div>
  <h3>lang (as an attribute name)</h3>
  <p>denotes an attribute whose value is a language code for the natural language of the content of any element; its value is inherited. This name is reserved by virtue of its definition in the XML specification.</p>
</div>
<div>
  <h4>Notes</h4>
  <p>Attempting to install the relevant ISO 2- and 3-letter codes as the enumerated possible values is probably never going to be a realistic possibility.</p>
  <p>See BCP 47 at
    <a href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">http://www.rfc-editor.org/rfc/bcp/bcp47.txt</a>and the IANA language subtag registry at
    <a href="http://www.iana.org/assignments/language-subtag-registry">http://www.iana.org/assignments/language-subtag-registry</a>for further information.</p>
  <p>The union allows for the 'un-declaration' of xml:lang with the empty string.</p>
</div>

Source

<xsd:complexType name="TextType">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">This type allows the xml:lang attribute to associate a specific language with an element's string content.</xsd:documentation>
  </xsd:annotation>
  <xsd:simpleContent>
    <xsd:extension base="xsd:string">
      <xsd:attribute ref="xml:lang"/>
    </xsd:extension>
  </xsd:simpleContent>
</xsd:complexType>

Complex Type cpe:LogicalTestType

Namespace

http://cpe.mitre.org/language/2.0

Annotations

The logical-test element appears as a child of a
platform element, and may also be nested to create more complex logical
tests. The content consists of one or more elements: fact-ref, and
logical-test children are permitted. The operator to be applied, and
optional negation of the test, are given as attributes.

Diagram

Used by

Elements

cpe:LogicalTestType/cpe:logical-test, cpe:logical-test

Children

cpe:fact-ref, cpe:logical-test

Attributes

QName	Type	Use
negate	xsd:boolean	required
operator	cpe:operatorEnumeration	required

Source

<xsd:complexType name="LogicalTestType">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">The logical-test element appears as a child of a platform element, and may also be nested to create more complex logical tests. The content consists of one or more elements: fact-ref, and logical-test children are permitted. The operator to be applied, and optional negation of the test, are given as attributes.</xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:element name="logical-test" type="cpe:LogicalTestType" minOccurs="0" maxOccurs="unbounded"/>
    <xsd:element ref="cpe:fact-ref" minOccurs="0" maxOccurs="unbounded">
      <xsd:annotation>
        <xsd:documentation xml:lang="en"/>
      </xsd:annotation>
    </xsd:element>
  </xsd:sequence>
  <xsd:attribute name="operator" type="cpe:operatorEnumeration" use="required"/>
  <xsd:attribute name="negate" type="xsd:boolean" use="required"/>
</xsd:complexType>

Complex Type cpe:FactRefType

Namespace

http://cpe.mitre.org/language/2.0

Annotations

The fact-ref element appears as a
child of a logical-test element. It is simply a reference to a CPE Name that
always evaluates to a Boolean result.

Diagram

Used by

Element

cpe:fact-ref

Attributes

QName	Type	Use
name	cpe:namePattern	required

Source

<xsd:complexType name="FactRefType">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">The fact-ref element appears as a child of a logical-test element. It is simply a reference to a CPE Name that always evaluates to a Boolean result.</xsd:documentation>
  </xsd:annotation>
  <xsd:attribute name="name" type="cpe:namePattern" use="required"/>
</xsd:complexType>

Simple Type cpe:operatorEnumeration

Namespace

http://cpe.mitre.org/language/2.0

Annotations

The OperatorEnumeration simple type defines
acceptable operators. Each operator defines how to evaluate multiple
arguments.

Diagram

Type

restriction of xsd:string

Facets

enumeration	AND
enumeration	OR

Used by

Attribute

cpe:LogicalTestType/@operator

Source

<xsd:simpleType name="operatorEnumeration">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">The OperatorEnumeration simple type defines acceptable operators. Each operator defines how to evaluate multiple arguments.</xsd:documentation>
  </xsd:annotation>
  <xsd:restriction base="xsd:string">
    <xsd:enumeration value="AND"/>
    <xsd:enumeration value="OR"/>
  </xsd:restriction>
</xsd:simpleType>

Attribute cpe:FactRefType / @name

Namespace

No namespace

Type

cpe:namePattern

Facets

pattern

[c][pP][eE]:/[AHOaho]?(:[A-Za-z0-9\._\-~%]*){0,6}

Used by

Complex Type

cpe:FactRefType

Source

<xsd:attribute name="name" type="cpe:namePattern" use="required"/>

Attribute cpe:LogicalTestType / @operator

Namespace

No namespace

Type

cpe:operatorEnumeration

Facets

enumeration	AND
enumeration	OR

Used by

Complex Type

cpe:LogicalTestType

Source

<xsd:attribute name="operator" type="cpe:operatorEnumeration" use="required"/>

Attribute cpe:LogicalTestType / @negate

Namespace

No namespace

Type

xsd:boolean

Used by

Complex Type

cpe:LogicalTestType

Source

<xsd:attribute name="negate" type="xsd:boolean" use="required"/>

Attribute cpe:PlatformType / @id

Namespace

No namespace

Annotations

The id attribute holds a locally unique
name for the platform. There is no defined format for this id, it just has
to be unique to the containing language document.

Type

xsd:anyURI

Used by

Complex Type

cpe:PlatformType

Source

<xsd:attribute name="id" type="xsd:anyURI" use="required">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">The id attribute holds a locally unique name for the platform. There is no defined format for this id, it just has to be unique to the containing language document.</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>