Schema blackBoxTemplateConfig.xsd


element blackBoxTemplateConfig
diagram blackBoxTemplateConfig_diagrams/blackBoxTemplateConfig_p1.png
annotation
documentation
Configuration of a black box template object. It contains of three main components: key definitions, file definitions, and valueFile definition.

complexType BlackBoxTemplateConfigXML
diagram blackBoxTemplateConfig_diagrams/blackBoxTemplateConfig_p2.png

element BlackBoxTemplateConfigXML/keyDefinitions
diagram blackBoxTemplateConfig_diagrams/blackBoxTemplateConfig_p3.png
attributes
Name  Type  Use  Default  Fixed  Annotation
defaultKeyPrefix  xs:string  optional      
documentation
Specify the default prefix for the alias keys.
defaultKeySuffix  xs:string  optional      
documentation
Specify the default suffix for the alias keys.
annotation
documentation
Define keys which need to be substituted by valiues in the template files. Specify the prefix and suffix for the keys.

element BlackBoxTemplateConfigXML/files
diagram blackBoxTemplateConfig_diagrams/blackBoxTemplateConfig_p4.png
annotation
documentation
Specify the files with template definitions.

element BlackBoxTemplateConfigXML/valuesFile
diagram blackBoxTemplateConfig_diagrams/blackBoxTemplateConfig_p5.png
annotation
documentation
Specify the file containing the KEY and VALUE pairs.

complexType BlackBoxTemplateFilesXML
diagram blackBoxTemplateConfig_diagrams/blackBoxTemplateConfig_p6.png

element BlackBoxTemplateFilesXML/file
diagram blackBoxTemplateConfig_diagrams/blackBoxTemplateConfig_p7.png
attributes
Name  Type  Use  Default  Fixed  Annotation
templateFile  xs:string  required      
documentation
Name of the template file.
targetFile  xs:string  required      
documentation
Name of the target file.
annotation
documentation
Specify the file definitions where KEY strings need to be replaced by values. Specify template file and target file.

complexType TemplateFileKeysXML
diagram blackBoxTemplateConfig_diagrams/blackBoxTemplateConfig_p8.png

element TemplateFileKeysXML/keyId
diagram blackBoxTemplateConfig_diagrams/blackBoxTemplateConfig_p9.png
annotation
documentation
Specify the id of the key defined in the keyDefinitions section.

complexType TemplateFileXML
diagram blackBoxTemplateConfig_diagrams/blackBoxTemplateConfig_p10.png
attributes
Name  Type  Use  Default  Fixed  Annotation
templateFile  xs:string  required      
documentation
Name of the template file.
targetFile  xs:string  required      
documentation
Name of the target file.

attribute TemplateFileXML/@templateFile
annotation
documentation
Name of the template file.

attribute TemplateFileXML/@targetFile
annotation
documentation
Name of the target file.

element TemplateFileXML/keys
diagram blackBoxTemplateConfig_diagrams/blackBoxTemplateConfig_p11.png
annotation
documentation
Specify list of keys to be replaced in the templateFile.

complexType TemplateKeyDefinitionsXML
diagram blackBoxTemplateConfig_diagrams/blackBoxTemplateConfig_p12.png
attributes
Name  Type  Use  Default  Fixed  Annotation
defaultKeyPrefix  xs:string  optional      
documentation
Specify the default prefix for the alias keys.
defaultKeySuffix  xs:string  optional      
documentation
Specify the default suffix for the alias keys.

attribute TemplateKeyDefinitionsXML/@defaultKeyPrefix
annotation
documentation
Specify the default prefix for the alias keys.

attribute TemplateKeyDefinitionsXML/@defaultKeySuffix
annotation
documentation
Specify the default suffix for the alias keys.

element TemplateKeyDefinitionsXML/key
diagram blackBoxTemplateConfig_diagrams/blackBoxTemplateConfig_p13.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
The id to be referred to by the alias.
name  xs:string  required      
documentation
The name to be associated with the aliased key.
targetType  xs:string  optional  org.openda.blackbox.config.KeyTypeString    
documentation
The data type to which the alias key will be replaced (default String).
keyPrefix  xs:string  optional      
documentation
Specify the prefix for the alias key.
keySuffix  xs:string  optional      
documentation
Specify the suffix for the alias key.
annotation
documentation
Create list of keys, stating their id, name and targetType. The id is to be used in the file definition section. The name is the "KEY" - string to be placed in the template file.

complexType TemplateKeyDefinitionXML
diagram blackBoxTemplateConfig_diagrams/blackBoxTemplateConfig_p14.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
The id to be referred to by the alias.
name  xs:string  required      
documentation
The name to be associated with the aliased key.
targetType  xs:string  optional  org.openda.blackbox.config.KeyTypeString    
documentation
The data type to which the alias key will be replaced (default String).
keyPrefix  xs:string  optional      
documentation
Specify the prefix for the alias key.
keySuffix  xs:string  optional      
documentation
Specify the suffix for the alias key.

attribute TemplateKeyDefinitionXML/@id
annotation
documentation
The id to be referred to by the alias.

attribute TemplateKeyDefinitionXML/@name
annotation
documentation
The name to be associated with the aliased key.

attribute TemplateKeyDefinitionXML/@targetType
annotation
documentation
The data type to which the alias key will be replaced (default String).

attribute TemplateKeyDefinitionXML/@keyPrefix
annotation
documentation
Specify the prefix for the alias key.

attribute TemplateKeyDefinitionXML/@keySuffix
annotation
documentation
Specify the suffix for the alias key.

simpleType BlackBoxTemplateKeyTypesXML


XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy