Defining annotations, 115 | Sybase XML specification

Chapter 2 Building an XML model

Defining annotations

You define annotations when you want to add information about an XML model.

Annotations are made of Documentation and Application Information:

♦Documentation allows you to write a URI reference or any well-formed XML content that will give extra information about XML objects or documents

♦Application Information allows you to write a URI reference or any well- formed XML content that will be used by applications for processing instructions

There are two kinds of annotations:

♦Local annotations, for extra information on XML objects. You can define them through the Annotation page of an object property sheet. They have no property sheet

♦Global annotations, for extra information on XML models or schemas. You can define them through the Items page or the External Schemas page of a model property sheet. They have a property sheet

Generated schema of a global annotation:

XSM User's Guide

115

Page 127

Image 127

Sybase XML manual Defining annotations, 115

Contents

11.1 Sybase PowerDesigner Last Revised June Contents 102 Managing external shortcuts through references and data100 101 Working with an XML model 139 Mapping XML Model objects to OOM objects 171 Why reverse engineer an XSD, a DTD or an XDRHow to reverse engineer an XSD, a DTD or an XDR 169 Vii Exchanging data with databases supporting XML 215 Viii Audience SubjectDocumentation primer Business Process Model User’s Guide Conceptual Data Model User’s Guide To work with the CDMPhysical Data Model User’s Guide Object Oriented Model Getting Started Typographic conventions Bibliography BeforeInsertTrigger template Xii XML Model Basics Contents Functional overview Demo models What is an XML model? About XML Objects in an XML model XSD Tool Object Description Objects in a diagram Tool Sequence symbol Choice symbol All symbol Tool Element symbol Group symbol Complex type symbol All Choosing the XML language of an XML model Defining the XML model environmentNot certified resource file ™ To change the XML language of an XML model Changing the XML language of an XML modelLanguage Description Changes concerning simple and complex types Option Description Selecting extended model definitions at model creation Defining model options ™ To define XML model options XML model extended dependencies Defining the XML model environment Defining model properties Defining an XML model™ To define the properties of an XML model Property Description Model General Model Detail Button Moves item Model ItemsTool Tooltip Description Model External Schemas Model Namespaces XML Model Basics Model Preview Creating an XML model ™ To create a new XML model using the New model option Creating an XML model using the New model option Defining an XML model List of templates ™ To detach an XML model from a workspace Opening an existing XML modelDetaching an XML model from the workspace ™ To open an existing XML model Closing an XML model Saving and closing an XML modelSaving an XML Model Defining an XML model Building an XML model Defining an XML diagram XML diagram basics Why build an XML diagram? Group Symbols feature Creating an XML diagramExpand/Expand All/Collapse/Arrange Symbols features Defining elements Defining element properties Global and local elements in XDR files Element general properties Defining elements Property or XDR files Element detail properties Building an XML model Element attributes properties Element mapping properties Element constraints propertiesElement Sources Attributes Mapping Creating an element™ To create an element from the palette Defining elements Tool Action Result How to link a child object to an element? Pointer indications Defining the attributes of an element Building an XML model Global and local attributes in XDR files Attribute general properties Defining attributes Attribute values Attribute detail properties Element values with XDR Adding an attribute to an element™ To add an attribute to an element Linking child elements to a parent element Modifying element display preferencesPreference Description Group particles Defining group particlesGroup particle Value of the order attribute in XDR Items list Group particles properties ™ To create a group particle from an element property sheet Creating a group particle From the palette Name and code uniqueness Clicking an element symbol with the Element tool How to link a child object to a group particle? Defining Any properties Any general properties ™ To create an Any Defining Any Attribute properties Modifying the Any display preference For example Any Attribute general properties Defining a unique constraint Defining identity constraints Unique fields properties Unique general properties Defining a key constraint Key general properties Defining a keyRef constraintKey fields properties Defining identity constraints KeyRef general properties Creating an identity constraintKeyRef fields properties Defining an identity constraint selector Syntax Description XPath abbreviated syntax ™ To display a selector property sheet Defining selector general properties Defining an identity constraint field ™ To create an identity constraint field Defining field general properties Building an XML model Defining a group of elements Defining groups Defining group properties Groups in DTD and XDR files ™ To create a group of elements from the palette Creating a group of elements Defining groups How to link a child object to a group of elements? Defining a group of attributes Modifying the group display preference Attribute group general properties Defining attribute group properties Attributes Attribute groupProperties ™ To create an attribute group from the Browser tree view Creating an attribute group Defining groups Data types References Example of shortcuts through a reference and a data type Defining simple types What is a simple type?Type of derivation Description ™ To create a simple type from the Browser tree view Defining simple type propertiesModifying the simple type display preference Creating a simple type Building an XML model Defining complex types What is a complex type? Complex type general properties Defining complex type properties Complex type attributes properties Complex type detail properties Icon Tool Description Complex type mapping propertiesComplex Type Sources Creating a complex type Modifying complex type display preferences ™ To create a complex type from the palette How to link a child object to a complex type? Pointer indications General property Defining simple content propertiesSimple content ™ To create a simple content General properties Defining complex content propertiesComplex content ™ To create a complex content 102 Defining derivationsDeriving by extension Derivation in element property sheet ™ To define a derivation by extension Defining extension103 Restriction on a simple type Deriving by restriction104 105 Defining restriction facetsRestriction general Restriction detail 106 Facet generalRestriction Enumerations 107 Restriction patterns ™ To create a restriction on a simple type Creating a restriction on a simple type108 109 110 111 Restriction on a complex typeEnumeration and Pattern facets ™ To create a restriction on a complex type 112 Deriving by list ™ To define a simple type derivation by list Deriving by union113 114 Union generalUnion types ™ To define a simple type derivation by union 115 Defining annotations Annotation items properties Defining annotation propertiesDefining documentation properties Annotation general property Application information general properties Documentation contentDefining application information properties Documentation general properties Creating an annotation Application information content118 119 Defining notation properties Defining notations120 ™ To create a notation from the Browser tree view Creating a notation121 Entity name Reference Value Defining entitiesDefining entity properties 122 ™ To create an entity from the Browser tree view Creating an entity123 124 Import general Defining import, include and redefineDefining an import Defining import properties ™ To create an import from the Browser tree view Creating an import126 127 Defining an includeDefining include properties Include general 128 Defining a redefineCreating an include ™ To create an include from the Browser tree view Redefine general Defining redefine properties129 130 Creating a redefineRedefine items ™ To create a redefine from the Browser tree view 131 Business rule general properties What is a business rule?Defining business rules Defining business rule properties Type Description Example Creating a business ruleBusiness rule expression property 133 134 ™ To create a business rule from the List of Business Rules 135 Applying a business rule to an XML object 136 ™ To apply a business rule to an XML object 137 Column in the List of business rules 138 139 Working with an XML model 140 Levels of problem severityChecking an XML model XML model check options 141 Selecting objects in the diagramXML model object selection in the Check Model Automatic correction ™ To check an XML model Checking an XML model142 143 Selecting all or clearing all check boxes 144 ™ To display errors and warnings selected in the last checkDisplaying previously applied check options in an XML model Dockable result window 145 Making corrections based on XML model check resultsDisplay the Check toolbar Contextual menu ™ To make automatic corrections to an XML model Making manual corrections to an XML modelMaking automatic corrections to an XML model ™ To make manual corrections to an XML model Invalid cardinality XML Model objects verified by Check ModelGroup particle check Existence of particle Shortcut code uniqueness Model checkIdentifier uniqueness Undefined identifier Business rule name and code uniqueness Business rule check in an XSMData source check Missing namespaces 150 File checkData source name and code uniqueness Existence of model Entity name and code uniqueness Entity checkEmbedded file name uniqueness Existence of external file location Simple type check Include checkComplex type check Undefined type Element checkExistence of attribute Element name and code uniqueness 154 Undefined reference Group name and code uniqueness Group check155 156 Attribute checkNotation check Attribute name and code uniqueness Attribute group name and code uniqueness Attribute group checkNotation name and code uniqueness Undefined notation Existence of attributes Undefined schema location and namespaceImport check Redefine check Existence of fields Key checkExistence of component Key name and code uniqueness KeyRef name and code uniqueness KeyRef check160 Unique name and code uniqueness Unique check161 Extended link name and code uniqueness Extended object checkExtended link check Extended object name and code uniqueness Partial object replication Replication checkExtension check Restriction check Existence of facet Simple type list check164 165 Simple type union checkAnnotation check Existence of items 166 Mapping objects in an XML modelUnderstanding object mapping Defining data sources in an XML model 167 Data source properties in an XML modelCreating a data source in an XML model ™ To create a data source in an XML model 168 XML Model object PDM object Mapping XML Model objects to PDM objectsMapping elements 169 170 Mapping complex typesTool Description 171 Mapping XML Model objects to OOM objectsXML Model object OOM object ™ To create a mapping for an element Creating a mapping for an XML object172 173 174 Create From Sources and Generate Mapping tools ™ To modify the mapping of an attribute Modifying the mapping of an attribute175 176 Manipulating XML objects graphicallyLocal objects Move Drag and drop Global objectsExample converting a local object into a global object ™ To convert a local object into a global object 178 After conversions 179 Comparing and merging XML models PDM object Generated object in an XML model Generating an XML model from a Physical Data ModelGenerating XML Model objects 180 181 Generating and updating an XML modelXML model naming conventions Generate new XML Clearing the Preserve modifications check box Update existingDefining XML model generation options XML model 183 Check model before generation ™ To generate a new XML model from a PDM Generating a new XML model from a PDM184 Preserve modifications Result Updating an existing XML modelGenerating an XML model from a package 185 Preserve modifications ™ To update an existing XML model by generating from a PDM186 187 Merging models 188 Generating an XML model from an Object- Oriented ModelOOM Object Generated object in an XML model 189 190 191 ™ To generate a new XML model from an OOM Generating a new XML model from an OOM192 193 194 ™ To update an existing XML model by generating from an OOM 195 ™ To create a model report What is a report?Editing an XML model report Creating an XML model report 197 Language in a template Inserting diagram198 199 200 201 Generating an XSD, a DTD or an XDR file Why generate an XSD file?Why generate a DTD file? Why generate an XDR file? 203 Defining generation parametersCheck model Defining generation targets 204 Using the Move up or down arrowsDefining generation options Defining generation tasks Model targeted with Generated file How to generate an XSD, a DTD or an XDR file?Parameter entities during DTD generation 205 206 207 Reverse engineering an XSD, a DTD or an XDR file What is reverse engineering?Why reverse engineer an XSD, a DTD or an XDR file? How to reverse engineer an XSD, a DTD or an XDR file? Convert Unique References Reverse engineering optionsReverse engineering target models Reverse engineering to a new XML model 210 211 212 Reverse engineering to an existing XML model 213 Auto-layout 214 215 Exchanging data with databases supporting XML 216 Why use XML in databases? Mapping XML objects to PDM objects Generating an annotated schema for Microsoft SQL Server217 218 219 220 221 222 Extended model definitions 223 Annotated schema preview 224 225 Reinforcing mapping with extended attributes Annotation Description 226 227 228 229 ™ To generate an annotated schema for Oracle Generating an annotated schema for Oracle230 231 232 233 234 235 236 Type of storage Type of mapping Description Generating a DAD file for IBM DB2™ To generate a DAD file for IBM DB2 237 238 Generating a DAD file for IBM DB2 239 240 241 242 243 DAD file preview Extended attribute Description 244 245 246 247 248 ™ To generate SQL/XML queries Generating SQL/XML queries249 250 Generating SQL/XML queries 251 252 253 254 255 Generating from an XML model Generation option Description Generation basicsTarget models parameters 256 257 Generating from an XML model 258 Generating an XML model from an XML model Why generate an XML model from an XML model?259 260 Generating an XML model from an XML model 261 Generating a new XML model from an XML model 262 ™ To generate a new XML model from an XML model 263 Updating an existing XML model 264 265 266 267 268 XSM User’s Guide 269 XPath UnionUnique XML language 271 Index 272 PowerDesigner 273 IBM DB2 274 275 276 XML 277 278