Common Attribute Types

An attribute type serves as a constraint on the value of a plan or component attribute. If an attribute does not list a specific type, its value is unconstrained.

The following sections describe the format of the attribute types that are used by the schema. \p{N} represents all Unicode numbers, while \p{L} represents all Unicode letters.

entityName Attribute Type

Attributes of type entityName have a maximum length of 512 characters and match the following pattern:

[\p{N}\p{L}-_. ]+

An example of an entityName would be _Continent_Region.database server.

As a special case, dot (.) and dot-dot (..) are not permitted to be entity names.

systemName Attribute Type

Attributes of type systemName consist of a simpleSystemName that has a maximum length of 64 characters, and optionally, a pluginName that also has a maximum length of 64 characters, as follows:

simpleSystemName
pluginName#simpleSystemName

Where simpleSystemName matches the following pattern:

[\p{L}_][\p{N}\p{L}-_. +]*

An example of a systemName would be simpleSystemName of CENTRAL_AMERICA.TEXAS_systemusers.500k+ and pluginName of com.sun.sjsas81 for a pluginName#simpleSystemName of com.sun.sjsas81#CENTRAL_AMERICA.TEXAS_systemusers.500k+.

identifier Attribute Type

Attributes of type identifier have a maximum length of 512 characters and match the following pattern:

[\p{L}_][\p{N}\p{L}_]*

An example of an identifier would be NORTH_AMERICA_800AAA_555ABCD_.

pathName Attribute Type

Attributes of type pathName have a maximum length of 512 characters and match one of the following patterns:

/
/pathPart

where pathPart is [\p{N}\p{L}-_. ]+

You can use the / separator to string together pathParts, such as /pathPart/pathPart/pathPart.

As a special case, dot (.) and dot-dot (..) are not permitted to be included in pathPart.

pathReference Attribute Type

Attributes of type pathReference have the following syntax:

pathReference:
    absolutePath
    relativePath

absolutePath:
    /
    /relativePath

relativePath:
    relativePathStart
    relativePathStart/relativePath

relativePathStart:
    .
    ..
    pathPart

modifierEnum Attribute Type

Attributes of type modifierEnum have either ABSTRACT or FINAL as their value. In general, a value of ABSTRACT indicates that the associated entity must be overridden by a derived component. A value of FINAL indicates that the associated entity cannot be overridden.

accessEnum Attribute Type

Attributes of type accessEnum have one of these values:

• PUBLIC – Indicates that the associated entity can be accessed by any object

• PROTECTED – Indicates that the associated entity can be accessed by derived components and other entities that are in the same path

• PATH – Indicates that the associated entity can be accessed by other entities that are in the same path

• PRIVATE – Indicates that the associated entity can be accessed by the declaring component

version Attribute Type

Attributes of type version match the following pattern:

[0-9]+\.[0-9]+

Examples of version are lowest, 0.0, to highest, 9.9 value.

schemaVersion Attribute Type

Attributes of type schemaVersion can have only one of these values, 5.0 , 5.1, or 5.2.

HostEntityName Attribute Type

Attributes of type HostEntityName have a maximum length of 64, and can include any combination of Unicode letters and numbers.

pluginName Attribute Type

Attributes of type pluginName have a maximum length of 64, and can include any combination of Unicode letters and numbers.

pluginHostEntityName Attribute Type

Attributes of type pluginHostEntityName have a maximum length of 64, and can include any combination of Unicode letters and numbers.