Copyright © [2002]. Roger L. Costello. All Rights Reserved. 1 XML Schemas (Primer)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 1 XML Schemas http://www.w3.org/TR/xmlschema-0/ (Primer) http://www.w3.org/TR/xmlschema-1/ (Structures) http://www.w3.org/TR/xmlschema-2/ (Datatypes) Roger L. Costello XML Technologies Course

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 2 Acknowledgements Special thanks to the following people for their help in answering my unending questions and/or for finding errors and making suggestions: –Henry Thompson –Robert Melskens –Jonathan Rich –Francis Norton –Rick Jelliffe –Curt Arnold

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 3 Viewing this Tutorial This tutorial is best viewed in slide show mode –Under the View menu select Slide Show Periodically you will see an icon at the bottom, right of the slide indicating that it is time to do a lab exercise. I strongly recommend that you stop and do the lab exercise to obtain the maximum benefit from this tutorial.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 4 Why 3 Powerpoint Documents? xml-schemas1.ppt and xml-schemas2.ppt cover all of XML schemas. I split it up into 2 documents only because this one got too big. The material in xml-schema2.ppt is equally important as the material in this document. xml-schemas3.ppt is my start on a "reference manual". I didn't complete it, but it has a lot of very useful material in it.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 5 Taxonomy of Schema Languages Definition: a grammar-based schema specifies what elements may be used in an XML instance document, the order of the elements, the number of occurrences of each element, and the content and datatype of each element and attribute. Definition: an assertion-based schema makes assertions about the relationships that must hold between the elements and attributes in an XML instance document. Schema Languages grammar-based assertion-based DTD XML Schema Relax NG Schematron

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 6 Schema Validators Command Line Only –XSV by Henry Thompson ftp://ftp.cogsci.ed.ac.uk/pub/XSV/XSV12.EXE Has a Programmatic API –xerces by Apache http://www.apache.org/xerces-j/index.html –IBM Schema Quality Checker (Note: this tool is only used to check your schema. It cannot be used to validate an instance document against a schema.) http://www.alphaworks.ibm.com/tech/xmlsqc –MSXML4.0 http://www.microsoft.com GUI Oriented –XML Spy http://www.xmlspy.com –Oxygen XML http://www.oxygenxml.com

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 7 30 Second Intro On the next 3 slides is a very quick, high- level introduction to XML Schemas. The purpose is to give you the "big picture" before we jump into all the nitty-gritty details of creating XML Schemas.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 9 Example 32.904237 73.620290 2 Is this data valid? To be valid, it must meet these constraints (data business rules): 1. The location must be comprised of a latitude, followed by a longitude, followed by an indication of the uncertainty of the lat/lon measurements. 2. The latitude must be a decimal with a value between -90 to +90 3. The longitude must be a decimal with a value between -180 to +180 4. For both latitude and longitude the number of digits to the right of the decimal point must be exactly six digits. 5. The value of uncertainty must be a non-negative integer 6. The uncertainty units must be either meters or feet. We can express all these data constraints using XML Schemas

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 10 Validating your data 32.904237 73.620290 2 Declare a location element. Require that its content be latitude, longitude, and uncertainty. Declare a latitude element. Require that its value be between -90 and +90. Declare a longitude element. Require that its value be between -180 and +180. Declare a uncertainty element with a units attribute. Require that the element's value be between 0 and 10. Require that the attribute's value be either feet or meters. XML Schema validator Data is ok! XML

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 11 What does an XML Schema accomplish? Declare a location element. Require that its content be latitude, longitude, and uncertainty. Declare a latitude element. Require that its value be between -90 and +90. Declare a longitude element. Require that its value be between -180 and +180. Declare a uncertainty element with a units attribute. Require that the element's value be between 0 and 10. Require that the attribute's value be either feet or meters. XML Schema Answer: It creates an XML vocabulary:,,, It specifies the contents of each element, and the restrictions on the content.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 12 It does one more thing... Namespace = http://www.example.org/target Declare a location element. Require that its content be latitude, longitude, and uncertainty. Declare a latitude element. Require that its value be between -90 and +90. Declare a longitude element. Require that its value be between -180 and +180. Declare a uncertainty element with a units attribute. Require that the element's value be between 0 and 10. Require that the attribute's value be either feet or meters. XML Schema An XML Schema specifies that the XML vocabulary that is being created shall be in a "namespace"

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 14 Constraints: in a Document or in Middleware (code)? An XML Schema is an XML document. The constraints on the data are expressed in a document. All of the constraints could be expressed in a programming language (e.g., Java), in your system's middleware. Why express data constraints in a document? Answer: by expressing the data constraints in a document (and using XML to express the constraints) then the schema itself becomes information! Not only is the XML instance data being checked information, but the schema itself is information. Thus, just like the XML instance document, the schema can be shipped around, mined, morphed, searched, etc. This is why it's best to express your data constraints in an XML document, and not bury them within code in middleware. Information is king!

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 16 Purpose of XML Schemas (and Relax NG and DTDs) Specify: –the structure of instance documents "this element contains these elements, which contains these other elements, etc" –the datatype of each element/attribute "this element shall hold an integer with the range 0 to 12,000" (DTDs don't do too well with specifying datatypes like this)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 17 Motivation for XML Schemas People are dissatisfied with DTDs –It's a different syntax You write your XML (instance) document using one syntax and the DTD using another syntax --> bad, inconsistent –Limited datatype capability DTDs support a very limited capability for specifying datatypes. You can't, for example, express "I want the element to hold an integer with a range of 0 to 12,000" Desire a set of datatypes compatible with those found in databases –DTD supports 10 datatypes; XML Schemas supports 44+ datatypes

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 18 Highlights of XML Schemas XML Schemas are a tremendous advancement over DTDs: –Enhanced datatypes 44+ versus 10 Can create your own datatypes –Example: "This is a new type based on the string type and elements of this type must follow this pattern: ddd-dddd, where 'd' represents a digit". –Written in the same syntax as instance documents less syntax to remember –Object-oriented'ish Can extend or restrict a type (derive new type definitions on the basis of old ones) –Can express sets, i.e., can define the child elements to occur in any order –Can specify element content as being unique (keys on content) and uniqueness within a region –Can define multiple elements with the same name but different content –Can define elements with nil content –Can define substitutable elements - e.g., the "Book" element is substitutable for the "Publication" element.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 19 Let's Get Started! Convert the BookStore.dtd (next page) to the XML Schema syntax –for this first example we will make a straight, one-to-one conversion, i.e., Title, Author, Date, ISBN, and Publisher will hold strings, just like is done in the DTD –We will gradually modify the XML Schema to use stronger types

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 21 ATTLIST ELEMENT ID #PCDATA NMTOKEN ENTITY CDATA BookStore Book Title Author Date ISBN Publisher This is the vocabulary that DTDs provide to define your new vocabulary

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 22 element complexType schema sequence http://www.w3.org/2001/XMLSchema string integer boolean BookStore Book Title Author Date ISBN Publisher http://www.books.org (targetNamespace) This is the vocabulary that XML Schemas provide to define your new vocabulary One difference between XML Schemas and DTDs is that the XML Schema vocabulary is associated with a name (namespace). Likewise, the new vocabulary that you define must be associated with a name (namespace). With DTDs neither set of vocabulary is associated with a name (namespace) [because DTDs pre-dated namespaces].

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 23 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns="http://www.books.org" elementFormDefault="qualified"> BookStore.xsd (see example01) xsd = Xml-Schema Definition (explanations on succeeding pages)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 24 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns="http://www.books.org" elementFormDefault="qualified"> <!ELEMENT Book (Title, Author, Date, ISBN, Publisher)>

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 25 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns="http://www.books.org" elementFormDefault="qualified"> All XML Schemas have "schema" as the root element.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 26 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns="http://www.books.org" elementFormDefault="qualified"> The elements and datatypes that are used to construct schemas - schema - element - complexType - sequence - string come from the http://…/XMLSchema namespace

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 28 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns="http://www.books.org" elementFormDefault="qualified"> Indicates that the elements defined by this schema - BookStore - Book - Title - Author - Date - ISBN - Publisher are to go in the http://www.books.org namespace

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 30 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns="http://www.books.org" elementFormDefault="qualified"> This is referencing a Book element declaration. The Book in what namespace? Since there is no namespace qualifier it is referencing the Book element in the default namespace, which is the targetNamespace! Thus, this is a reference to the Book element declaration in this schema. The default namespace is http://www.books.org which is the targetNamespace!

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 31 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns="http://www.books.org" elementFormDefault="qualified"> This is a directive to any instance documents which conform to this schema: Any elements used by the instance document which were declared in this schema must be namespace qualified.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 32 Referencing a schema in an XML instance document <BookStore xmlns ="http://www.books.org" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.books.org BookStore.xsd"> My Life and Times Paul McCartney July, 1998 94303-12021-43892 McMillin Publishing... 1. First, using a default namespace declaration, tell the schema-validator that all of the elements used in this instance document come from the http://www.books.org namespace. 2. Second, with schemaLocation tell the schema-validator that the http://www.books.org namespace is defined by BookStore.xsd (i.e., schemaLocation contains a pair of values). 3. Third, tell the schema-validator that the schemaLocation attribute we are using is the one in the XMLSchema-instance namespace. 1 2 3

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 34 Referencing a schema in an XML instance document BookStore.xml BookStore.xsd targetNamespace="http://www.books.org" schemaLocation="http://www.books.org BookStore.xsd" - defines elements in namespace http://www.books.org - uses elements from namespace http://www.books.org A schema defines a new vocabulary. Instance documents use that new vocabulary.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 35 Note multiple levels of checking BookStore.xmlBookStore.xsd XMLSchema.xsd (schema-for-schemas) Validate that the xml document conforms to the rules described in BookStore.xsd Validate that BookStore.xsd is a valid schema document, i.e., it conforms to the rules described in the schema-for-schemas

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 36 Default Value for minOccurs and maxOccurs The default value for minOccurs is "1" The default value for maxOccurs is "1" Equivalent! Do Lab1

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 37 Qualify XMLSchema, Default targetNamespace In the first example, we explicitly qualified all elements from the XML Schema namespace. The targetNamespace was the default namespace. BookStore Book Title Author Date ISBN Publisher http://www.books.org (targetNamespace) http://www.w3.org/2001/XMLSchema element complexType schema sequence string integer boolean

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 38 Default XMLSchema, Qualify targetNamespace Alternatively (equivalently), we can design our schema so that XMLSchema is the default namespace. BookStore Book Title Author Date ISBN Publisher http://www.books.org (targetNamespace) http://www.w3.org/2001/XMLSchema element complexType schema sequence string integer boolean

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 39 <schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns:bk="http://www.books.org" elementFormDefault="qualified"> (see example02) Note that http://…/XMLSchema is the default namespace. Consequently, there are no namespace qualifiers on - schema - element - complexType - sequence - string

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 40 <schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns:bk="http://www.books.org" elementFormDefault="qualified"> Here we are referencing a Book element. Where is that Book element defined? In what namespace? The bk: prefix indicates what namespace this element is in. bk: has been set to be the same as the targetNamespace.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 41 "bk:" References the targetNamespace BookStore Book Title Author Date ISBN Publisher http://www.books.org (targetNamespace) http://www.w3.org/2001/XMLSchema bk Do Lab1.1 element complexType schema sequence string integer boolean Consequently, bk:Book refers to the Book element in the targetNamespace.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 42 Inlining Element Declarations In the previous examples we declared an element and then we ref’ed to that element declaration. Alternatively, we can inline the element declarations. On the following slide is an alternate (equivalent) way of representing the schema shown previously, using inlined element declarations.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 43 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns="http://www.books.org" elementFormDefault="qualified"> (see example03) Note that we have moved all the element declarations inline, and we are no longer ref'ing to the element declarations. This results in a much more compact schema! This way of designing the schema - by inlining everything - is called the Russian Doll design.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 44 Do Lab 2 (see example03) Anonymous types (no name) <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns="http://www.books.org" elementFormDefault="qualified">

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 46 (see example04) <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns="http://www.books.org" elementFormDefault="qualified"> Named type The advantage of splitting out Book's element declarations and wrapping them in a named type is that now this type can be reused by other elements.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 47 Please note that: is equivalent to: Element A references the complexType foo. Element A has the complexType definition inlined in the element declaration.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 48 type Attribute or complexType Child Element, but not Both! An element declaration can have a type attribute, or a complexType child element, but it cannot have both a type attribute and a complexType child element. …

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 49 Summary of Declaring Elements (two ways to do it) A simple type (e.g., xsd:string) or the name of a complexType (e.g., BookPublication) … 1 2 A nonnegative integer A nonnegative integer or "unbounded" Note: minOccurs and maxOccurs can only be used in nested (local) element declarations.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 50 Problem Defining the Date element to be of type string is unsatisfactory (it allows any string value to be input as the content of the Date element, including non-date strings). – We would like to constrain the allowable content that Date can have. Modify the BookStore schema to restrict the content of the Date element to just date values (actually, year values. See next two slides). Similarly, constrain the content of the ISBN element to content of this form: d-ddddd-ddd-d or d-ddd-ddddd-d or d-dd-dddddd-d, where 'd' stands for 'digit'

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 51 The date Datatype A built-in datatype (i.e., schema validators know about this datatype) This datatype is used to represent a specific day (year-month-day) Elements declared to be of type date must follow this form: CCYY-MM-DD –range for CC is: 00-99 –range for YY is: 00-99 –range for MM is: 01-12 –range for DD is: 01-28 if month is 2 01-29 if month is 2 and the gYear is a leap gYear 01-30 if month is 4, 6, 9, or 11 01-31 if month is 1, 3, 5, 7, 8, 10, or 12 –Example: 1999-05-31 represents May 31, 1999

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 52 The gYear Datatype A built-in datatype (Gregorian calendar year) Elements declared to be of type gYear must follow this form: CCYY –range for CC is: 00-99 –range for YY is: 00-99 –Example: 1999 indicates the gYear 1999

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 53 (see example05) <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns="http://www.books.org" elementFormDefault="qualified"> Here we are defining a new (user-defined) datatype, called ISBNType. Declaring Date to be of type gYear, and ISBN to be of type ISBNType (defined above)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 54 "I hereby declare a new type called ISBNType. It is a restricted form of the string type. Elements declared of this type must conform to one of the following patterns: - First Pattern: 1 digit followed by a dash followed by 5 digits followed by another dash followed by 3 digits followed by another dash followed by 1 more digit, or - Second Pattern: 1 digit followed by a dash followed by 3 digits followed by another dash followed by 5 digits followed by another dash followed by 1 more digit, or - Third Pattern: 1 digit followed by a dash followed by 2 digits followed by another dash followed by 6 digits followed by another dash followed by 1 more digit." These patterns are specified using Regular Expressions. In a few slides we will see more of the Regular Expression syntax.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 56 or ? When do you use the complexType element and when do you use the simpleType element? –Use the complexType element when you want to define child elements and/or attributes of an element –Use the simpleType element when you want to create a new type that is a refinement of a built- in type (string, date, gYear, etc)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 57 Built-in Datatypes Primitive Datatypes –string –boolean –decimal –float –double –duration –dateTime –time –date –gYearMonth –gYear –gMonthDay Atomic, built-in –"Hello World" –{true, false, 1, 0} –7.08 – 12.56E3, 12, 12560, 0, -0, INF, -INF, NAN – P1Y2M3DT10H30M12.3S – format: CCYY-MM-DDThh:mm:ss – format: hh:mm:ss.sss – format: CCYY-MM-DD – format: CCYY-MM – format: CCYY – format: --MM-DD Note: 'T' is the date/time separator INF = infinity NAN = not-a-number

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 58 Built-in Datatypes (cont.) Primitive Datatypes –gDay –gMonth –hexBinary –base64Binary –anyURI –QName –NOTATION Atomic, built-in – format: ---DD (note the 3 dashes) – format: --MM –a hex string –a base64 string –http://www.xfront.com –a namespace qualified name –a NOTATION from the XML spec

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 59 Built-in Datatypes (cont.) Derived types –normalizedString –token –language –IDREFS –ENTITIES –NMTOKEN –NMTOKENS –Name –NCName –ID –IDREF –ENTITY –integer –nonPositiveInteger Subtype of primitive datatype – A string without tabs, line feeds, or carriage returns – String w/o tabs, l/f, leading/trailing spaces, consecutive spaces –any valid xml:lang value, e.g., EN, FR,... –must be used only with attributes –part (no namespace qualifier) –must be used only with attributes –456 –negative infinity to 0

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 60 Built-in Datatypes (cont.) Derived types –negativeInteger –long –int –short –byte –nonNegativeInteger –unsignedLong –unsignedInt –unsignedShort –unsignedByte –positiveInteger Subtype of primitive datatype – negative infinity to -1 – -9223372036854775808 to 9223372036854775807 – -2147483648 to 2147483647 – -32768 to 32767 – -127 to 128 – 0 to infinity – 0 to 18446744073709551615 – 0 to 4294967295 – 0 to 65535 –0 to 255 –1 to infinity Do Lab 3 Note: the following types can only be used with attributes (which we will discuss later): ID, IDREF, IDREFS, NMTOKEN, NMTOKENS, ENTITY, and ENTITIES.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 61 Creating your own Datatypes A new datatype can be defined from an existing datatype (called the "base" type) by specifying values for one or more of the optional facets for the base type. Example. The string primitive datatype has six optional facets: –length –minLength –maxLength –pattern –enumeration –whitespace (legal values: preserve, replace, collapse)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 62 Example of Creating a New Datatype by Specifying Facet Values 1. This creates a new datatype called 'TelephoneNumber'. 2. Elements of this type can hold string values, 3. But the string length must be exactly 8 characters long and 4. The string must follow the pattern: ddd-dddd, where 'd' represents a 'digit'. (Obviously, in this example the regular expression makes the length facet redundant.) 1 2 3 4

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 63 Another Example This creates a new type called shape. An element declared to be of this type must have either the value circle, or triangle, or square.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 64 Facets of the integer Datatype The integer datatype has 8 optional facets: –totalDigits –pattern –whitespace –enumeration –maxInclusive –maxExclusive –minInclusive –minExclusive

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 65 Example This creates a new datatype called 'EarthSurfaceElevation'. Elements declared to be of this type can hold an integer. However, the integer is restricted to have a value between -1290 and 29035, inclusive.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 66 General Form of Creating a New Datatype by Specifying Facet Values … Facets: - length - minlength - maxlength - pattern - enumeration - minInclusive - maxInclusive - minExclusive - maxExclusive... Sources: - string - boolean - number - float - double - duration - dateTime - time...

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 67 Multiple Facets - "and" them together, or "or" them together? An element declared to be of type TelephoneNumber must be a string of length=8 and the string must follow the pattern: 3 digits, dash, 4 digits. An element declared to be of type shape must be a string with a value of either circle, or triangle, or square. Patterns, enumerations => "or" them together All other facets => "and" them together

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 68 Creating a simpleType from another simpleType Thus far we have created a simpleType using one of the built-in datatypes as our base type. However, we can create a simpleType that uses another simpleType as the base. See next slide.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 70 Fixing a Facet Value Sometimes when we define a simpleType we want to require that one (or more) facet have an unchanging value. That is, we want to make the facet a constant. simpleTypes which derive from this simpleType may not change this facet.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 72 Element Containing a User- Defined Simple Type Example. Create a schema element declaration for an elevation element. Declare the elevation element to be an integer with a range -1290 to 29035 5240 Here's one way of declaring the elevation element:

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 73 Element Containing a User- Defined Simple Type (cont.) Here's an alternative method for declaring elevation: The simpleType definition is defined inline, it is an anonymous simpleType definition. The disadvantage of this approach is that this simpleType may not be reused by other elements.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 75 Annotating Schemas The element is used for documenting the schema, both for humans and for machines. –Use for providing a comment to humans –Use for providing a comment to machines The content is any well-formed XML Note that annotations have no effect on schema validation The following constraint is not expressible with XML Schema: The value of element A should be greater than the value of element B. So, we need to use a separate tool (e.g., Schematron) to check this constraint. We will express this constraint in the appinfo section (below). A should be greater than B

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 76 Where Can You Put Annotations? You cannot put annotations at just any random location in the schema. Here are the rules for where an annotation element can go: –annotations may occur before and after any global component –annotations may occur only at the beginning of non-global components

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 77 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns="http://www.books.org" elementFormDefault="qualified"> Can put annotations only at these locations Suppose that you want to annotate, say, the Date element declaration. What do we do? See next page...

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 78 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns="http://www.books.org" elementFormDefault="qualified"> This is how to annotate the Date element! Inline the annotation within the Date element declaration.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 79 Two Optional Attributes for the documentation Element In the previous example we showed with no attributes. Actually, it can have two attributes: –source: this attribute contains a URL to a file which contains supplemental information –xml:lang: this attribute specifies the language that the documentation was written in

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 80 One Optional Attribute for the appinfo Element In the previous example we showed with no attributes. Actually, it can have one attribute: –source: this attribute contains a URL to a file which contains supplemental information

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 81 Up for a Breath Wow! We have really been into the depths of XML Schemas. Let's back up for a moment and look at XML Schemas from a "big picture" point of view.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 82 Code to check the structure and content (datatype) of the data Code to actually do the work "In a typical program, up to 60% of the code is spent checking the data!" - source unknown Save $$$ using XML Schemas Continued -->

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 83 Code to check the structure and content of the data Code to actually do the work If your data is structured as XML, and there is a schema, then you can hand the data-checking task off to a schema validator. Thus, your code is reduced by up to 60%!!! Big $$ savings! Save $$$ using XML Schemas (cont.)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 84 Classic use of XML Schemas (Trading Partners - B2B) Supplier Consumer P.O. Schema Validator P.O. Schema Software to Process P.O. "P.O. is okay" P.O. (Schema at third-party, neutral web site)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 85 What are XML Schemas? Data Model With XML Schemas you specify how your XML data will be organized, and the datatypes of your data. That is, with XML Schemas you model how your data is to be represented in an instance document. A Contract Organizations agree to structure their XML documents in conformance with an XML Schema. Thus, the XML Schema acts as a contract between the organizations. A rich source of metadata An XML Schema document contains lots of data about the data in the XML instance documents, such as the datatype of the data, the data's range of values, how the data is related to another piece of data (parent/child, sibling relationship), i.e., XML Schemas contain metadata

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 86 No Limits Two slides back we showed the classic use of XML Schemas - to validate your data (so that you don't have to write code to do it) However, there are many other uses for XML Schemas. Schemas are a wonderful source of metadata. Truly, your imagination is the only limit on its usefulness. On the next slide I show how to use the metadata provided by XML Schemas to create a GUI. The slide after that shows how to automatically generate an API using the metadata in XML Schemas. Following that is a slide showing how to create a "smart editor" using XML Schemas.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 89 XML Schema --> Smart Editor P.O. Schema Smart Editor (e.g., XML Spy) Helps you build your instance documents. For example, it pops up a menu showing you what is valid next. It knows this by looking at the XML Schema!

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 91 Regular Expressions Recall that the string datatype has a pattern facet. The value of a pattern facet is a regular expression. Below are some examples of regular expressions: Regular Expression - Chapter \d - Chapter \d - a*b - [xyz]b - a?b - a+b - [a-c]x Example - Chapter 1 - b, ab, aab, aaab, … - xb, yb, zb - b, ab - ab, aab, aaab, … - ax, bx, cx

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 92 Regular Expressions (cont.) Regular Expression –[a-c]x –[-ac]x –[ac-]x –[^0-9]x –\Dx –Chapter\s\d –(ho){2} there –(ho\s){2} there –.abc –(a|b)+x Example –ax, bx, cx –-x, ax, cx –ax, cx, -x – any non-digit char followed by x – Chapter followed by a blank followed by a digit –hoho there – any (one) char followed by abc –ax, bx, aax, bbx, abx, bax,...

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 93 Regular Expressions (cont.) a{1,3}x a{2,}x \w\s\w ax, aax, aaax aax, aaax, aaaax, … word character (alphanumeric plus dash) followed by a space followed by a word character [a-zA-Z-[Ol]]* A string comprised of any lower and upper case letters, except "O" and "l" \. The period "." (Without the backward slash the period means "any character")

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 94 Regular Expressions (cont.) \n \r \t \\ \| \- \^ \? \* \+ \{ \}  \[ \] linefeed carriage return tab The backward slash \ The vertical bar | The hyphen - The caret ^ The question mark ? The asterisk * The plus sign + The open curly brace { The close curly brace } The open paren ( The close paren ) The open square bracket [ The close square bracket ]

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 95 Regular Expressions (concluded) \p{L} \p{Lu} \p{Ll} \p{N} \p{Nd} \p{P} \p{Sc} A letter, from any language An uppercase letter, from any language A lowercase letter, from any language A number - Roman, fractions, etc A digit from any language A punctuation symbol A currency sign, from any language "currency sign from any language, followed by one or more digits from any language, optionally followed by a period and two digits from any language" $45.99 ¥300

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 96 Example R.E. [1-9]?[0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5] 0 to 99 100 to 199 200 to 249250 to 255 This regular expression restricts a string to have values between 0 and 255. … Such a R.E. might be useful in describing an IP address...

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 97 IP Datatype Definition <xsd:pattern value="(([1-9]?[0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3} ([1-9]?[0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])"> Datatype for representing IP addresses. Examples, 129.83.64.255, 64.128.2.71, etc. This datatype restricts each field of the IP address to have a value between zero and 255, i.e., [0-255].[0-255].[0-255].[0-255] Note: in the value attribute (above) the regular expression has been split over two lines. This is for readability purposes only. In practice the R.E. would all be on one line.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 98 Regex for different platform line breaks? Different systems use different line break characters. How do you handle this in XML? Read on and find out. Consider this XML document: (line break characters are explicitly shown) \r\n This is a \r\n simple paragraph. What \r\n do you think of it? \r\n \r\n When an XML parser reads in this document it "normalizes" ALL line breaks. Thus, after normalization the XML document looks like this: \n This is a \n simple paragraph. What \n do you think of it? \n \n Things to note: 1. All line breaks have been normalized to \n. Consequence: you don't have to be concerned about different platforms using different line break characters since all XML documents will have their line break characters normalized to \n regardless of the platform. (So, if you're writing an XML Schema regex expression you can simply use \n to indicate line break, regardless of the platform.) 2. The xml:space="preserve" attribute has no impact on line break normalization. 3. Suppose that you want a line break character in your XML document, other than \n. For example, suppose that you want \r in your XML document. By default, it would get normalized to \n. To prevent this, use a character reference: Do Lab 5

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 99 Derived Types We can do a form of subclassing complexType definitions. We call this "derived types" –derive by extension: extend the parent complexType with more elements –derive by restriction: create a type which is a subset of the base type. There are two ways to subset the elements: redefine a base type element to have a restricted range of values, or redefine a base type element to have a more restricted number of occurrences.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 100 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns="http://www.books.org" elementFormDefault="qualified"> Note that BookPublication extends the Publication type, i.e., we are doing Derive by Extension (see example06)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 101 Elements declared to be of type BookPublication will have 5 child elements - Title, Author, Date, ISBN, and Publisher. Note that the elements in the derived type are appended to the elements in the base type.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 104 Derive by Restriction Elements of type SingleAuthorPublication will have 3 child elements - Title, Author, and Date. However, there must be exactly one Author element. Note that in the restriction type you must repeat all the declarations from the base type (except when the base type has an element with minOccurs="0" and the subtype wishes to delete it. See next slide).

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 105 Deleting an element in the base type Note that in this subtype we have eliminated the Author element, i.e., the subtype is just comprised of an unbounded number of Title elements followed by a single Date element. If the base type has an element with minOccurs="0", and the subtype wishes to not have that element, then it can simply leave it out.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 106 Derive by Restriction (cont.) You might (legitimately) ask: –why do I have to repeat all the declarations from the base type? Why can't I simply show the delta (i.e., show those declarations that are changed)? –What's the advantage of doing derived by restriction if I have to repeat everything? I'm certainly not saving on typing. Answer: –Even though you have to retype everything in the base type there are advantages to explicitly associating a type with a base type. In a few slides we will see element substitution - the ability to substitute one element for another. A restriction of element substitution is that the substituting element have a type that derives from the type of the element it is substituting. Thus, it is beneficial to link the type. –Also, later we will see that an element’s content model may be substituted by the content model of derived types. Thus, the content of an element that has been declared to be of type Publication can be substituted with a SingleAuthorPublication content since SingleAuthorPublication derives from Publication. We will discuss this type substitutability in detail later.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 107 Prohibiting Derivations Sometimes we may want to create a type and disallow all derivations of it, or just disallow extension derivations, or disallow restriction derivations. –Rationale: "For example, I may create a complexType and make it publicly available for others to use. However, I don't want them to extend it with their proprietary extensions or subset it to remove, say, copyright information." (Jon Cleaver) Publication cannot be extended nor restricted Publication cannot be restricted Publication cannot be extended

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 108 Terminology: Declaration vs Definition In a schema: –You declare elements and attributes. Schema components that are declared are those that have a representation in an XML instance document. –You define components that are used just within the schema document(s). Schema components that are defined are those that have no representation in an XML instance document. Declarations: - element declarations - attribute declarations Definitions: - type (simple, complex) definitions - attribute group definitions - model group definitions

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 109 Terminology: Global versus Local Global element declarations, global type definitions: –These are element declarations/type definitions that are immediate children of Local element declarations, local type definitions: –These are element declarations/type definitions that are nested within other elements/types.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 110 Global type definition Global element declaration Local element declarations Local type definition <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns="http://www.books.org" elementFormDefault="qualified">

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 111 Global vs Local … What's the Big Deal? So what if an element or type is global or local. What practical impact does it have? –Answer: only global elements/types can be referenced (i.e., reused). Thus, if an element/type is local then it is effectively invisible to the rest of the schema (and to other schemas).

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 112 Element Substitution Oftentimes in daily conversation there are several ways to express something. –In Boston we use the words "T" and "subway" interchangeably. For example, "we took the T into town", or "we took the subway into town". Thus, "T" and "subway" are substitutable. Which one is used may depend upon what part of the state you live in, what mood you're in, or any number of factors. We would like to be able to express this substitutability in XML Schemas. –That is, we would like to be able to declare in a schema an element called "subway", an element called "T", and state that "T"may be substituted for "subway". Instance documents can then use either or, depending on their preference.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 113 substitutionGroup We can define a group of substitutable elements (called a substitutionGroup) by declaring an element (called the head) and then declaring other elements which state that they are substitutable for the head element. subway is the head element T is substitutable for subway So what's the big deal? - Anywhere a head element can be used in an instance document, any member of the substitutionGroup can be substituted!

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 114 Red Line Schema: Instance doc: Red Line Alternative instance doc (substitute T for subway): This example shows the element being substituted with the element.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 115 International Clients We can use substitutionGroups to create elements customized for our international clients. On the next slide is shown a Spanish version of the element.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 117 Notes about using substitutionGroup The elements that are declared to be in the substitution group (e.g., subway and T) must be declared as global elements If the type of a substitutionGroup element is the same as the head element then you can omit it (the type) –In our Subway example we could have omitted the type attribute in the declaration of the T element since it is the same as Subway’s type (xsd:string).

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 118 Notes about using substitutionGroup (cont.) The type of every element in the substitutionGroup must be the same as, or derived from, the type of the head element. This type must be the same as "xxx" or, it must be derived from "xxx".

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 120 BookType and MagazineType Derive from PublicationType PublicationType BookTypeMagazineType In order for Book and Magazine to be in a substitutionGroup with Publication, their type (BookType and MagazineType, respectively) must be the same as, or derived from Publication's type (PublicationType)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 122 Illusions: The Adventures of a Reluctant Messiah Richard Bach 1977 0-440-34319-4 Dell Publishing Co. Natural Health 1999 The First and Last Freedom J. Krishnamurti 1954 0-06-064831-7 Harper & Row can contain any element in the substitutionGroup with Publication!

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 123 Blocking Element Substitution An element may wish to block other elements from substituting with it. This is achieved by adding a block attribute.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 124 Red Line Schema: Instance doc: Red Line Not allowed! Note: there is no error in declaring T to be substitutable with subway. The error occurs only when you try to do substitution in the instance document.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 125 One more Note about substitutionGroup 1. Transitive: if element A can substitute for element B, and element B can substitute for element C, then element A can substitute for element C. A --> B --> C then A --> C 2. Non-symmetric: if element A can substitute for element B, it is not the case that element B can substitute for element A. Do Lab 7

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 126 Attributes On the next slide I show a version of the BookStore DTD that uses attributes. Then, on the following slide I show how this is implemented using XML Schemas.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 127 <!ATTLIST Book Category (autobiography | non-fiction | fiction) #REQUIRED InStock (true | false) "false" Reviewer CDATA " "> BookStore.dtd

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 129 "Instance documents are required to have the Category attribute (as indicated by use="required"). The value of Category must be either autobiography, non-fiction, or fiction (as specified by the enumeration facets)." Note: attributes can only have simpleTypes (i.e., attributes cannot have child elements).

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 130 Summary of Declaring Attributes (two ways to do it) required optional prohibited The "use" attribute must be optional if you use default or fixed. xsd:string xsd:integer xsd:boolean... … 1 2

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 131 use=" prohibited " Question: When would use=" prohibited " be used? Answer: This value is useful when you create a master type which lists all possible attributes, and then subtypes can delete the attributes that are not needed. Here's an example:

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 132 use --> use it only with Local Attribute Declarations The "use" attribute only makes sense in the context of an element declaration. Example: "for each Book element, the Category attribute is required". When declaring a global attribute do not specify a "use"

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 133 … … Local attribute declaration. Use the "use" attribute here. Global attribute declaration. Must NOT have a "use" ("use" only makes sense in the context of an element)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 134 Inlining Attributes On the next slide is another way of expressing the last example - the attributes are inlined within the Book declaration rather than being separately defined in an attributeGroup.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 136 Notes about Attributes The attribute declarations always come last, after the element declarations. The attributes are always with respect to the element that they are defined (nested) within. … "bar and boo are attributes of foo"

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 137 These attributes apply to the element they are nested within (Book) That is, Book has three attributes - Category, InStock, and Reviewer. Do Lab 8.a,

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 138 Element with Simple Content and Attributes Example. Consider this: 5440 The elevation element has these two constraints: - it has a simple (integer) content - it has an attribute called units How do we declare elevation? (see next slide)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 139 1. elevation contains an attribute. - therefore, we must use 2. However, elevation does not contain child elements (which is what we generally use to indicate). Instead, elevation contains simpleContent. 3. We wish to extend the simpleContent (an integer)... 4. with an attribute. 1 2 3 4

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 140 elevation - use Stronger Datatype In the declaration for elevation we allowed it to hold any integer. Further, we allowed the units attribute to hold any string. Let's restrict elevation to hold an integer with a range 0 - 12,000 and let's restrict units to hold either the string "feet" or the string "meters"

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 144 Restricting the simpleContent Value space: -1290 to 29035 Attribute: units (fixed at "feet") SurfaceElevation restrict the value space Value space: 0 to 120 Attribute: units (fixed at "feet") BostonAreaSurfaceElevation

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 146 Extending simpleContent versus Restricting simpleContent Z1 Z2 Y1 must be a simpleType (either built-in or user-defined). Z1 must be one or more attribute declarations. Y2 must be a complexType with simpleContent. Z2 must be a simpleType (either built-in or user-defined).

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 147 Summary of Declaring Elements 1. Element with Simple Content. Declaring an element using a built-in type: Declaring an element using a user-defined simpleType: An alternative formulation of the above shapes example is to inline the simpleType definition:

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 148 Summary of Declaring Elements (cont.) 2. Element Contains Child Elements Defining the child elements inline: An alternate formulation of the above Person example is to create a named complexType and then use that type:

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 152 complexContent versus simpleContent With complexContent you extend or restrict a complexType With simpleContent you extend or restrict a simpleType … X must be a complexType … Y must be a simpleType versus Do Lab 8.b, 8.c

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 153 group Element The group element enables you to group together element declarations. Note: the group element is just for grouping together element declarations, no attribute declarations allowed!

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 155 Note about group Group definitions must be global... Cannot inline the group definition. Instead, you must use a ref here and define the group globally.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 156 Expressing Alternates DTD: XML Schema: <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.travel.org" xmlns="http://www.travel.org" elementFormDefault="qualified"> (see example10) Note: the choice is an exclusive-or, that is, transportation can contain only one element - either train, or plane, or automobile.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 157 Expressing Repeatable Choice <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.binary.org" xmlns="http://www.binary.org" elementFormDefault="qualified"> DTD: XML Schema: Notes: 1. An element can fix its value, using the fixed attribute. 2. When you don't specify a value for minOccurs, it defaults to "1". Same for maxOccurs. See the last example (transportation) where we used a element with no minOccurs or maxOccurs. (see example 11)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 158 fixed/default Element Values When you declare an element you can give it a fixed or default value. –Then, in the instance document, you can leave the element empty. … 0 or equivalently: … red or equivalently:

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 159 Using and <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.life.org" xmlns="http://www.life.org" elementFormDefault="qualified"> DTD: XML Schema:

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 160 Expressing Any Order <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.books.org" xmlns="http://www.books.org" elementFormDefault="qualified"> XML Schema: Problem: create an element, Book, which contains Author, Title, Date, ISBN, and Publisher, in any order (Note: this is very difficult and ugly with DTDs). means that Book must contain all five child elements, but they may occur in any order. (see example 12)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 161 Constraints on using Elements declared within must have a maxOccurs value of "1" (minOccurs can be either "0" or "1") If a complexType uses and it extends another type, then that parent type must have empty content. The element cannot be nested within either,, or another The contents of must be just elements. It cannot contain or Do Lab 9

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 162 Empty Element <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.photography.org" xmlns="http://www.photography.org" elementFormDefault="qualified"> Schema: Instance doc (snippet): Do Lab 10 DTD: (see example 13)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 163 No targetNamespace (noNamespaceSchemaLocation) Sometimes you may wish to create a schema but without associating the elements with a namespace. The targetNamespace attribute is actually an optional attribute of. Thus, if you don’t want to specify a namespace for your schema then simply don’t use the targetNamespace attribute. Consequences of having no namespace –1. In the instance document don’t namespace qualify the elements. –2. In the instance document, instead of using schemaLocation use noNamespaceSchemaLocation.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 164 (see example14) Note that there is no targetNamespace attribute, and note that there is no longer a default namespace. <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 165 <BookStore xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "BookStore.xsd"> My Life and Times Paul McCartney 1998 1-56592-235-2 McMillin Publishing … (see example14) 1. Note that there is no default namespace declaration. So, none of the elements are associated with a namespace. 2. Note that we do not use xsi:schemaLocation (since it requires a pair of values - a namespace and a URL to the schema for that namespace). Instead, we use xsi:noNamespaceSchemaLocation.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 166 Assembling an Instance Document from Multiple Schema Documents An instance document may be composed of elements from multiple schemas. Validation can apply to the entire XML instance document, or to a single element.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 167 <Library xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation= "http://www.book.org Book.xsd http://www.employee.org Employee.xsd"> My Life and Times Paul McCartney 1998 1-56592-235-2 Macmillan Publishing Illusions: The Adventures of a Reluctant Messiah Richard Bach 1977 0-440-34319-4 Dell Publishing Co. The First and Last Freedom J. Krishnamurti 1954 0-06-064831-7 Harper & Row John Doe 123-45-6789 Sally Smith 000-11-2345 Library.xml (see example 15) Validating against two schemas The elements are defined in Book.xsd, and the elements are defined in Employee.xsd. The,, and elements are not defined in any schema! 1. A schema validator will validate each Book element against Book.xsd. 2. It will validate each Employee element against Employee.xsd. 3. It will not validate the other elements.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 168 Lax Validation vs Strict Validation On the previous slide there were elements (Library, Books, and Employees) for which there was no schema to validate against. Lax validation is where the schema validator skips over elements for which no schema is available. Strict validation is where the schema validator requires validation of every element xsv performs lax validation. Thus, it will accept the instance document on the previous slide (but it will note validation="lax" in its output) All the other validators do strict validation. Consequently, they will reject the instance document on the previous slide.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 169 Assembling a Schema from Multiple Schema Documents The include element allows you to access components in other schemas –All the schemas you include must have the same namespace as your schema (i.e., the schema that is doing the include) –The net effect of include is as though you had typed all the definitions directly into the containing schema … LibraryBook.xsd LibraryEmployee.xsd Library.xsd

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 170 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.library.org" xmlns="http://www.library.org" elementFormDefault="qualified"> Library.xsd (see example 16) These are referencing element declarations in the other schemas. Nice!

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 171 Assembling a Schema from a Schema with no targetNamespace A schema can another schema which has no targetNamespace. The included components take on the targetNamespace of the schema that is doing the. This is called the Chameleon Effect. The components in the no-namespace schema are called Chameleon components.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 172 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"> Product.xsd (see example17) Note that this schema has no targetNamespace!

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 173 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.company.org" xmlns="http://www.company.org" elementFormDefault="qualified"> Company.xsd (see example17) This schema s Product.xsd. Thus, the components in Product.xsd are namespace-coerced to the company targetNamespace. Consequently, we can reference those components just as though they had originally been declared in a schema with the same targetNamespace.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 174 Assembling a Schema from Multiple Schema Documents with Different Namespaces The import element allows you to access elements and types in a different namespace <xsd:import namespace="A" schemaLocation="A.xsd"/> <xsd:import namespace="B" schemaLocation="B.xsd"/> … Namespace A A.xsd Namespace B B.xsd C.xsd

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 176 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.nikon.com" xmlns="http://www.nikon.com" elementFormDefault="qualified"> Nikon.xsd <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.olympus.com" xmlns="http://www.olympus.com" elementFormDefault="qualified"> Olympus.xsd <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.pentax.com" xmlns="http://www.pentax.com" elementFormDefault="qualified"> Pentax.xsd

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 177 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.camera.org" xmlns:nikon="http://www.nikon.com" xmlns:olympus="http://www.olympus.com" xmlns:pentax="http://www.pentax.com" elementFormDefault="qualified"> <xsd:import namespace="http://www.nikon.com" schemaLocation="Nikon.xsd"/> <xsd:import namespace="http://www.olympus.com" schemaLocation="Olympus.xsd"/> <xsd:import namespace="http://www.pentax.com" schemaLocation="Pentax.xsd"/> Camera.xsd (see example 18) These import elements give us access to the components in these other schemas. Here I am using the body_type that is defined in the Nikon namespace

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 178 <c:camera xmlns:c="http://www.camera.org" xmlns:nikon="http://www.nikon.com" xmlns:olympus="http://www.olympus.com" xmlns:pentax="http://www.pentax.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation= "http://www.camera.org Camera.xsd http://www.nikon.com Nikon.xsd http://www.olympus.com Olympus.xsd http://www.pentax.com Pentax.xsd"> Ergonomically designed casing for easy handling 300mm 1.2 1/10,000 sec to 100 sec The Camera instance uses elements from the Nikon, Olympus, and Pentax namespaces. Camera.xml (see example 18)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 179 Redundant! On the previous slide, the value of schemaLocation contained four pairs of values - one for camera, and three for each schema that it uses. The later three are redundant. Once you give the schema-validator the URL to the camera schema it will examine the camera schema and see the import elements, thus it will deduce the other schemas being used (Nikon, Olympus, and Pentax) The next slide shows the non-redundant version.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 180 <c:camera xmlns:c="http://www.camera.org" xmlns:nikon="http://www.nikon.com" xmlns:olympus="http://www.olympus.com" xmlns:pentax="http://www.pentax.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation= "http://www.camera.org Camera.xsd"> Ergonomically designed casing for easy handling 300mm 1.2 1/10,000 sec to 100 sec Camera.xml (non-redundant version)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 181 Note about using Include and Import The and elements must come before any element declarations or type definitions. Do Labs 11.a, 11.b, 11.c

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 182 Creating Lists There are times when you will want an element to contain a list of values, e.g., "The contents of the Numbers element is a list of numbers". Example: For a document containing a Lottery drawing we might have 12 49 37 99 20 67 How do we declare the element Numbers... (1) To contain a list of integers, and (2) Each integer is restricted to be between 1 and 99, and (3) The total number of integers in the list is exactly six.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 183 <LotteryDrawings xmlns="http://www.lottery.org" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation= "http://www.lottery.org Lottery.xsd"> July 1 21 3 67 8 90 12 July 8 55 31 4 57 98 22 July 15 70 77 19 35 44 11 Lottery.xml (see example19)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 184 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.lottery.org" xmlns="http://www.lottery.org" elementFormDefault="qualified"> Lottery.xsd

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 185 LotteryNumbers --> Need Stronger Datatyping The list in the previous schema has two problems: –It allows to contain an arbitrarily long list –The numbers in the list may be any positiveInteger We need to: –Restrict the list to length value="6" –Restrict the numbers to maxInclusive value="99"

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 186 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.lottery.org" xmlns="http://www.lottery.org" elementFormDefault="qualified"> Lottery.xsd (see example19)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 187 NumbersList is a list where the type of each item is OneToNinetyNine. LotteryNumbers restricts NumbersList to a length of six (i.e., an element declared to be of type LotteryNumbers must hold a list of numbers, between 1 and 99, and the length of the list must be exactly six).

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 188 Alternatively, This is read as: "We are creating a new type called LotteryNumbers. It is a restriction. At this point we can either use the base attribute or a simpleType child element to indicate the type that we are restricting (you cannot use both the base attribute and the simpleType child element). We want to restrict the type that is a list of OneToNinetyNine. We will restrict that type to a length of 6."

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 189 Notes about the list type You cannot create a list of lists –i.e., you cannot create a list type from another list type. You cannot create a list of complexTypes –i.e., lists only apply to simpleTypes In the instance document, you must separate each item in a list with white space (blank space, tab, or carriage return) The only facets that you may use with a list type are: –length: use this to specify the length of the list –minLength: use this to specify the minimum length of the list –maxLength: use this to specify the maximum length of the list –enumeration: use this to specify the values that the list may have –pattern: use this to specify the values that the list may have Do Lab 11.d

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 190 Creating a simpleType that is a Union of Types simpleType 1 simpleType 2 simpleType 1 + simpleType 2 Note: you can create a union of more than just two simpleTypes

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 191 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.CostelloReunion.org" xmlns="http://www.CostelloReunion.org" elementFormDefault="qualified"> Cont. -->

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 194 <Y2KFamilyReunion xmlns="http://www.CostelloReunion.org" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation= "http://www.CostelloReunion.org Y2KFamilyReunion.xsd"> Mary Pat Patti Christopher Elizabeth Judy Peter Tom Cheryl Marc Joe Roger Y2KFamilyReunion.xml (see example 20)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 195 Alternative … Version 2 of Y2KFamilyReunion.xsd (see example 21) A union of anonymous simpleTypes The disadvantage of creating the union type in this manner is that none of the simpleTypes are reusable.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 197 "maxOccurs" is a Union type! The value space for maxOccurs is the union of the value space for nonNegativeInteger with the value space of a simpleType which contains only one enumeration value - "unbounded". See next slide for how maxOccurs is defined in the schema-for- schemas (not exactly how it's defined in the schema-for-schemas, but it gives you the idea of how the schemas-for-schemas might implement it)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 198 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.maxOccurs.org" xmlns="http://www.maxOccurs.org" elementFormDefault="qualified"> (see example22)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 199 Summary of Defining simpleTypes 1. simpleType that uses a built-in base type: 2. simpleType that uses another simpleType as the base type:

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 200 Summary of Defining simpleTypes 3. simpleType that defines a list type: where the datatype OneToNinetyNine is declared as: 4. An alternate form of the above, where the list's datatype is specified using an inlined simpleType:

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 201 Summary of Defining simpleTypes 5. simpleType that defines a union type: where the datatype UnboundedType is declared as: 6. An alternate form of the above, where the datatype UnboundedType is specified using an inline simpleType:

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 202 any Element The element enables the instance document author to extend his/her document with elements not specified by the schema. Now an instance document author can optionally extend (after ) the content of elements with any element.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 203 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.repository.org" xmlns="http://www.repository.org" elementFormDefault="qualified"> SchemaRepository.xsd (see example23) Suppose that the instance document author discovers this schema repository, and wants to extend the elements with a element. He/she can do so! Thus, the instance document will be extended with an element never anticipated by the schema author. Wow!

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 204 <BookStore xmlns="http://www.BookRetailers.org" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation= "http://www. BookRetailers.org BookSeller.xsd http://www. repository.org SchemaRepository.xsd"> My Life and Times Paul McCartney 1998 94303-12021-43892 McMillin Publishing Roger Costello Illusions: The Adventures of a Reluctant Messiah Richard Bach 1977 0-440-34319-4 Dell Publishing Co. This instance document uses components from two different schemas.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 205 Extensible Instance Documents The element enables instance document authors to create instance documents containing elements above and beyond what was specified by the schema. The instance documents are said to be extensible. Contrast this schema with previous schemas where the content of all our elements were always fixed and static. We are empowering the instance document author with the ability to define what data makes sense to him/her!

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 206 Specifying the Namespace of Extension Elements allows the instance document to contain a new element, provided the element comes from a namespace other than the one the schema is defining (i.e., targetNamespace). allows a new element, provided it's from the specified namespace Note: you can specify a list of namespaces, separated by a blank space. One of the namespaces can be ##targetNamespace (see next) allows a new element, provided it's from the namespace that the schema is defining. allows an element from any namespace. This is the default. the new element must come from no namespace

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 207 anyAttribute The element enables the instance document author to extend his/her document with attributes not specified by the schema. Now an instance document author can add any number of attributes onto a element (as well as extend the element content).

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 208 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.repository.org" xmlns="http://www.repository.org" elementFormDefault="qualified"> SchemaRepository.xsd (see example24) Suppose that the instance document author discovers this schema, and wants to extend his/her elements with an id attribute. He/she can do so! Thus, the instance document will be extended with an attribute never anticipated by the schema author. Wow!

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 209 <BookSeller xmlns="http://www.BookRetailers.org" xmlns:sr="http://www.repository.org" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation= "http://www.BookRetailers.org BookSeller.xsd http://www.repository.org SchemaRepository.xsd"> My Life and Times Paul McCartney 1998 1-56592-235-2 McMillin Publishing Roger Costello Illusions: The Adventures of a Reluctant Messiah Richard Bach 1977 0-440-34319-4 Dell Publishing Co. BookStore.xml (see example24)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 210 Extensible Instance Documents The element enables instance document authors to create instance documents which contain attributes above and beyond what was specified by the schema. The instance documents are said to be extensible. Contrast this schema with previous schemas where the content of all our elements were always fixed and static. We are empowering the instance document author with the ability to define what data makes sense to him/her!

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 211 Specifying the Namespace of Extension Attributes allows the instance document to contain new attributes, provided the attributes come from a namespace other than the one the schema is defining (i.e., targetNamespace). allows new attributes, provided they're from the specified namespace. Note: you can specify a list of namespaces, separated by a blank space. One of the namespaces can be ##targetNamespace (see next) allows new attributes, provided they're from the namespace that the schema is defining. allows any attributes. This is the default. allows any unqualified attributes (i.e., the attributes comes from no namespace)

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 212 Smart Enough to Know you're not Smart Enough With the and elements we can design our schemas with the recognition that, as schema designers, we can never anticipate all the different kinds of data that instance document authors will want to use in the instance document. That is, we are smart enough to know that we're not smart enough to know all the different data instance document authors will require.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 213 Open Content Definition: an open content schema is one that allows instance documents to contain additional elements beyond what is declared in the schema. This is achieved by using the and elements in the schema. Sprinkling and elements liberally throughout your schema will yield benefits in terms of how evolvable your schema is. –See later slides for how open content enables the rapid evolution of schemas that is required in today's marketplace.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 214 Global Openness There is a range of openness that a schema may support - anywhere from having instance documents where new elements can be inserted anywhere (global openness), to instance documents where new elements can be inserted only at specific locations (localized openness)... This schema is allowing expansion before and after every element. Further, it is allowing for attribute expansion on every element. Truly, this is the ultimate in openness!

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 215 Localized Openness With localized openness we design our schema to allow instance documents to extend only at specific points in the document With this schema we are allowing instance documents to extend only at the end of Book's content model.

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 216 In today's rapidly changing market static schemas will be less commonplace, as the market pushes schemas to quickly support new capabilities. For example, consider the cellphone industry. Clearly, this is a rapidly evolving market. Any schema that the cellphone community creates will soon become obsolete as hardware/software changes extend the cellphone capabilities. For the cellphone community rapid evolution of a cellphone schema is not just a nicety, the market demands it! Suppose that the cellphone community gets together and creates a schema, cellphone.xsd. Imagine that every week NOKIA sends out to the various vendors an instance document (conforming to cellphone.xsd), detailing its current product set. Now suppose that a few months after cellphone.xsd is agreed upon NOKIA makes some breakthroughs in their cellphones - they create new memory, call, and display features, none of which are supported by cellphone.xsd. To gain a market advantage NOKIA will want to get information about these new capabilities to its vendors ASAP. Further, they will have little motivation to wait for the next meeting of the cellphone community to consider upgrades to cellphone.xsd. They need results NOW. How does open content help? That is described next. Suppose that the cellphone schema is declared "open". Immediately NOKIA can extend its instance documents to incorporate data about the new features. How does this change impact the vendor applications that receive the instance documents? The answer is - not at all. In the worst case, the vendor's application will simply skip over the new elements. More likely, however, the vendors are showing the cellphone features in a list box and these new features will be automatically captured with the other features. Let's stop and think about what has been just described … Without modifying the cellphone schema and without touching the vendor's applications, information about the new NOKIA features has been instantly disseminated to the marketplace! Open content in the cellphone schema is the enabler for this rapid dissemination. Dynamic Schema Evolution using Open Content Continued -->

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 217 Dynamic Schema Evolution using Open Content (cont.) Clearly some types of instance document extensions may require modification to the vendor's applications. Recognize, however, that the vendors are free to upgrade their applications in their own time. The applications do not need to be upgraded before changes can be introduced into instance documents. At the very worst, the vendor's applications will simply skip over the extensions. And, of course, those vendors do not need to upgrade in lock-step To wrap up this example … suppose that several months later the cellphone community reconvenes to discuss enhancements to the schema. The new features that NOKIA first introduced into the marketplace are then officially added into the schema. Thus completes the cycle. Changes to the instance documents have driven the evolution of the schema. Do Lab 12

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 218 Strategy for Defining Semantics of your XML Elements (by Mary Pulvermacher) Capture the semantics in the XML Schema –Describe the semantics within the element –Adopt the convention that every element and attribute have an annotation which provides information on the meaning Advantages: –The XML Schema will capture the data structure, meta-data, and relationships between the elements –Use of strong typing will capture much of the data content –The annotations can capture definitions and other explanatory information –The structure of the "definitions" will always be consistent with the structure used in the schema since they are linked –Since the schema itself is an XML document, we can use XSLT to extract the annotations and transform the "semantic" information into a format suitable for human consumption

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 1 XML Schemas (Primer)

Similar presentations

Presentation on theme: "Copyright © [2002]. Roger L. Costello. All Rights Reserved. 1 XML Schemas (Primer)"— Presentation transcript:

Similar presentations

About project

Feedback

Log in

Auth with social network:

Copyright © [2002]. Roger L. Costello. All Rights Reserved. 1 XML Schemas (Primer)

Similar presentations

Presentation on theme: "Copyright © [2002]. Roger L. Costello. All Rights Reserved. 1 XML Schemas (Primer)"— Presentation transcript:

Similar presentations

About project

Feedback