Примеры JAXB

Следующие разделы описывают, как использовать примеры приложения, которые включаются в пакет RI JAXB. Пакет RI JAXB доступен от http://jaxb.java.net. Загрузите и установите пакет RI JAXB. Примеры располагаются в jaxb-ri-install/samples/ каталоге. Эти примеры демонстрируют и полагаются на функции ключа JAXB и понятия. Следуйте за этими процедурами в представленном порядке.

После чтения этого раздела следует чувствовать себя довольными достаточно JAXB, что Вы можете:

• Генерируйте классы Java JAXB из XML-схемы
• Используйте полученные из схемы классы JAXB, чтобы неупорядочить и упорядочить контент XML в приложении Java
• Создайте дерево контента Java использование полученных из схемы классов JAXB
• Проверьте контента XML во время немаршалинга и во времени выполнения
• Настройте привязку схемы к Java JAXB

Этот документ описывает три набора примеров:

• Основные примеры (Изменяют, Упорядочивают, Неупорядочивают, Проверяют), демонстрируют основные понятия JAXB, такие как немаршалинг, маршалинг, и проверка допустимости контента XML, используя настройки по умолчанию и привязку.
• Настроить примеры (Настраивают Встроенный Преобразователь Типа данных, Внешний, Настраивают), демонстрируют различные способы настроить привязку значения по умолчанию XML-схем к объектам Java.
• Примеры Java к схеме показывают, как использовать аннотации, чтобы отобразить классы Java XML-схемы.

Основные и настраивают каталоги в качестве примера, содержат несколько основных файлов:

• po.xsd является XML-схемой, которая привыкла как входной к JAXB обязательный компилятор, и от которого будут сгенерированы полученные из схемы классы Java JAXB. Для Настраивания примеров Преобразователя Встроенного и Типа данных этот файл содержит встроенные обязательные настройки.
• po.xml является XML-файлом Заказа на поставку, содержащим демонстрационный контент XML, и это - файл, неупорядоченный в дерево контента Java в каждом примере. Этот файл является почти тем же самым в каждом примере; есть незначительные различия в контенте, чтобы выделить различные понятия JAXB.
• Main.java является основным Java class для каждого примера.
• build.xml является файлом проекта Муравья, предусмотренным Ваше удобство. Используйте инструмент Муравья, чтобы генерировать, скомпилировать, и выполнить полученные из схемы классы JAXB автоматически. Файл build.xml изменяется через примеры.
• MyDatatypeConverter.java в примере inline-customize является Java class, используемый, чтобы обеспечить пользовательские преобразования типа данных.
• binding.xjb во Внешнем Настраивает пример, внешний обязательный файл объявлений, который передают к JAXB обязательный компилятор, чтобы настроить значение по умолчанию привязка JAXB.

Следующие таблицы кратко описывают основное, настраивают, и Java к схеме примеры JAXB.

Таблица: Основные Примеры JAXB

Таблица: Настройте Примеры JAXB

Опции Компилятора JAXB

JAXB XJC схема обязательный компилятор преобразовывает, или связывает, исходная XML-схема к ряду классов контента JAXB в языке программирования Java. Компилятор class, xjc, обеспечивается как: xjc.sh на Солярисе/Linux и xjc.bat на Windows в пакете RI JAXB. xjc class включается в JDK библиотека class (в tools.jar).

И xjc.sh и xjc.bat берут те же самые параметры командной строки. Можно вывести на экран быстрые инструкции использования, вызывая сценарии без любых опций, или с переключателем -help. Синтаксис следующие:

xjc [-options ...] <schema file/URL/dir/jar>... [-b >bindinfo<] ...

Если dir будет определен, то все файлы схемы в каталоге будут скомпилированы. Если jar будет определен,/META-INF/sun-jaxb.episode то обязательный файл будет скомпилирован.

Параметры командной строки xjc следующие:

-nv

Не выполняйте строгую проверку допустимости входной схемы или схем. По умолчанию xjc выполняет строгую проверку допустимости исходной схемы перед обработкой. Отметьте, что это не означает, что обязательный компилятор не будет выполнять проверки допустимости; это только выполнит менее - строгая проверка допустимости.

-extension

По умолчанию XJC обязательный компилятор строго осуществляет правила, обрисованные в общих чертах в главе Совместимости Спецификации JAXB. В значении по умолчанию (строгий) режим Вы также ограничиваетесь использованием только обязательных настроек, определенных в спецификации. При использовании переключателя -extension Вам разрешают использовать Расширения Поставщика JAXB.

Файл -b

Определите один или более внешних обязательных файлов, чтобы обработать. (У каждого обязательного файла должен быть свой собственный переключатель -b.) Синтаксис внешних обязательных файлов гибок. У Вас может быть единственный обязательный файл, который содержит настройки для многократных схем, или можно повредить настройки в многократные файлы привязки. Кроме того, упорядочивание файлов схемы и обязательных файлов на командной строке не имеет значения.

dir -d

По умолчанию XJC обязательный компилятор генерирует классы контента Java в текущем каталоге. Используйте эту опцию, чтобы определить альтернативный выходной каталог. Каталог должен уже существовать; XJC обязательный компилятор не создает один для Вас.

Пакет -p

Определите альтернативный выходной каталог. По умолчанию XJC обязательный компилятор генерирует классы контента Java в текущем каталоге. Выходной каталог должен уже существовать; XJC обязательный компилятор не создает один для Вас.

Прокси -httpproxy

Определите прокси HTTP/HTTPS. Форматом является [user[:password]@]proxyHost[:proxyPort]. Старые опции -host И -port все еще поддерживаются Ссылочной Реализацией для обратной совместимости, но они были осуждены.

-httpproxyfile f

Работы как опция -httpproxy, но берут параметр в файле, чтобы защитить пароль.

Аргумент -classpath

Определите, где счесть клиентское приложение файлами class используемый настройками <xjc:superClass> и <jxb:javaType>.

Файл -catalog

Определите файлы каталога, чтобы разрешить внешние ссылки на сущность. Поддерживает TR9401, XCatalog, и XML ОАЗИСА формат Каталога. Для получения дополнительной информации см. XML Объект и документ Преобразователей URI или исследуйте пример приложения преобразователя каталога.

-readOnly

Вынудите XJC обязательный компилятор отметить сгенерированные источники Java как только для чтения. По умолчанию, XJC, обязательный компилятор не защищает от записи исходные файлы Java, которые это генерирует.

-npa

Подавите генерацию аннотаций уровня пакета в **/package-info.java. Используя этот переключатель заставляет сгенерированный код усваивать те аннотации в другие сгенерированные классы.

-no-header

Подавите генерацию заголовка файла с меткой времени.

-target (2.0|2.1)

Ведите себя как XJC 2.0 или 2.1 и генерируйте код, что doesnt используют любой XJC 2.2 функции.

-enableIntrospection

Позвольте корректной генерации Булевых методов get/методов set включить Бобовой пчеле Самоанализа.

-contentForWildcard

Генерирует свойство контента для типов с многократным xs:any полученные элементы.

-xmlschema

Обработайте входные схемы как XML-схему W3C (значение по умолчанию). Если Вы не определяете этот переключатель, Ваши входные схемы обрабатываются как XML-схема W3C.

-verbose

Будьте дополнительны многословный в выходе компилятора.

-quiet

Подавите выход компилятора, такой как информация о продвижении и предупреждения.

-help

Выведите на экран краткую сводку переключателей компилятора.

-version

Выведите на экран информацию о версии компилятора.

-fullversion

Выведите на экран компилятор полная информация о версии.

-Xinject-code

Введите определенные фрагменты кода Java в сгенерированный код.

-Xlocator

Включите исходной поддержке расположения сгенерированного кода.

-Xsync-methods

Генерируйте методы средства доступа с ключевым словом synchronized.

-mark-generated

Отметьте сгенерированный код с -@javax.annotation. Сгенерированная аннотация.

-episode FILE

Генерируйте файл эпизода для раздельной компиляции.

Опция Генератора Схемы JAXB

Генератор Схемы JAXB, schemagen, создает файл схемы для каждого пространства имен, на которое ссылаются в Ваших классах Java. Генератор схемы может быть запущен при использовании соответствующего сценария оболочки schemagen в каталоге bin для Вашей платформы. Генератор схемы обрабатывает исходные файлы Java только. Если Ваши источники Java ссылаются на другие классы, те источники должны быть доступными от Вашей системной переменной окружения ПУТИ К КЛАССУ; иначе ошибки произойдут, когда схема будет сгенерирована. Нет никакого способа управлять именем сгенерированных файлов схемы.

Можно вывести на экран быстрые инструкции использования, вызывая сценарии без любых опций или при использовании опции -help. Синтаксис следующие:

schemagen [-d path] 
    [java-source-files]

Опция пути -d определяет расположение сгенерированного процессором, и javac - генерировал файлы class.

О Привязке Схемы к Java

Когда Вы работаете, JAXB обязательный компилятор против XML-схемы po.xsd, используемой в основных примерах (Неупорядочьте Чтение, Измените, Упорядочивают, Неупорядочивают, Проверяют), JAXB, обязательный компилятор генерирует пакет Java под названием primer.po, содержащий классы, описанные в следующей таблице.

Таблица: полученные из схемы Классы JAXB в Основных Примерах

Эти классы и их определенная привязка к исходной XML-схеме для основных примеров описываются в следующей таблице.

Таблица: Привязка схемы к Java для Основных Примеров

<xsd:schema xmlns:xsd=
 "http://www.w3.org/2001/XMLSchema">

<xsd:complexType 
  name="PurchaseOrderType">
  <xsd:sequence>
    <xsd:element 
      name="shipTo" 
      type="USAddress"/>
    <xsd:element 
      name="billTo" 
      type="USAddress"/>
    <xsd:element 
      ref="comment" 
      minOccurs="0"/>
    <xsd:element 
      name="items"
      type="Items"/>
  </xsd:sequence>
  <xsd:attribute 
    name="orderDate"
    type="xsd:date"/>
</xsd:complexType>

<xsd:complexType 
  name="USAddress">
  <xsd:sequence>
    <xsd:element 
      name="name" 
      type="xsd:string"/>
    <xsd:element 
      name="street" 
      type="xsd:string"/>
    <xsd:element 
      name="city" 
      type="xsd:string"/>
    <xsd:element 
      name="state" 
      type="xsd:string"/>
    <xsd:element 
      name="zip" 
      type="xsd:decimal"/>
  </xsd:sequence>
  <xsd:attribute 
    name="country" 
    type="xsd:NMTOKEN" 
    fixed="US"/>
</xsd:complexType>

<xsd:complexType 
  name="Items">
  <xsd:sequence>
    <xsd:element 
      name="item" 
      minOccurs="1" 
      maxOccurs="unbounded">

<xsd:complexType>
  <xsd:sequence>
    <xsd:element 
      name="productName" 
      type="xsd:string"/>
    <xsd:element 
      name="quantity">
      <xsd:simpleType>
        <xsd:restriction 
          base="xsd:positiveInteger">
          <xsd:maxExclusive 
            value="100"/>
        </xsd:restriction>
      </xsd:simpleType>
    </xsd:element>
    <xsd:element 
      name="USPrice" 
      type="xsd:decimal"/>
    <xsd:element 
      ref="comment" 
      minOccurs="0"/>
    <xsd:element 
      name="shipDate" 
      type="xsd:date" 
      minOccurs="0"/>
  </xsd:sequence>
  <xsd:attribute 
    name="partNum" 
    type="SKU" 
    use="required"/>
</xsd:complexType>

</xsd:element>
</xsd:sequence>
</xsd:complexType>

<!-- Stock Keeping Unit, a code for 
    identifying products -->

<xsd:simpleType 
  name="SKU">
  <xsd:restriction 
    base="xsd:string">
    <xsd:pattern 
      value="\d{3}-[A-Z]{2}"/>
  </xsd:restriction>
</xsd:simpleType>

</xsd:schema>

Полученные из схемы Классы JAXB

Следующие разделы кратко объясняют функции следующих отдельных классов, сгенерированных JAXB обязательный компилятор для примеров:

• Класс Items
• Класс ObjectFactory
• Класс PurchaseOrderType
• Класс USAddress

Класс Items

В Items.java:

• Items class является частью пакета primer.po.
• class обеспечивает открытые интерфейсы для Items и ItemType.
• Контент в инстанцированиях этого class связывает с XML ComplexTypes Items и его дочерний элемент ItemType.
• Item обеспечивает метод getItem().
• ItemType обеспечивает методы для:
  • getPartNum();
  • setPartNum(String value);
  • getComment();
  • setComment(java.lang.String value);
  • getUSPrice();
  • setUSPrice(java.math.BigDecimal value);
  • getProductName();
  • setProductName(String value);
  • getShipDate();
  • setShipDate(java.util.Calendar value);
  • getQuantity();
  • setQuantity(java.math.BigInteger value);

Класс ObjectFactory

В ObjectFactory.java:

• ObjectFactory class является частью пакета primer.po.
• ObjectFactory обеспечивает методы фабрики для того, чтобы они инстанцировали интерфейсов Java, представляющих контент XML в дереве контента Java.
• Имена методов сгенерированы, конкатенируя:
  • Строковая константа create.
  • Все внешние имена class Java, если интерфейс контента Java вкладывается в пределах другого интерфейса.
  • Имя интерфейса контента Java.

Как пример, в этом случае, для Java соединяют интерфейсом с primer.po.Items.ItemType, ObjectFactory создает метод createItemsItemType().

Класс PurchaseOrderType

В PurchaseOrderType.java:

• PurchaseOrderType class является частью пакета primer.po.
• Контент в инстанцированиях этого class связывает с дочерним элементом XML-схемы под названием PurchaseOrderType.
• PurchaseOrderType является открытым интерфейсом, который обеспечивает следующие методы:
  • getItems();
  • setItems(primer.po.Items value);
  • getOrderDate();
  • setOrderDate(java.util.Calendar value);
  • getComment();
  • setComment(java.lang.String value);
  • getBillTo();
  • setBillTo(primer.po.USAddress value);
  • getShipTo();
  • setShipTo(primer.po.USAddress value);

Класс USAddress

В USAddress.java:

• USAddress class является частью пакета primer.po.
• Контент в инстанцированиях этого class связывает с элементом XML-схемы под названием USAddress.
• USAddress является открытым интерфейсом, который обеспечивает следующие методы:
  • getState();
  • setState(String value);
  • getZip();
  • setZip(java.math.BigDecimal value);
  • getCountry();
  • setCountry(String value);
  • getCity();
  • setCity(String value);
  • getStreet();
  • setStreet(String value);
  • getName();
  • setName(String value);