Example 4: Customizing individual values, pre-Java 5 code, and more

# Example 4: Customizing individual values, pre-Java 5 code, and more |

JiBX Basics Overview Getting Started Binding Compiler Binding on Load Runtime Extras Building JiBX Contributing License News and Status Support FAQ Mailing Lists Bugs User Comments Sponsors Start from Code Start from Code BindGen Example Code Example 1 Example 2 Example 3 Example 4 Customizations Reference SchemaGen Jibx2Wsdl Examples Customizations Start from Schema Start from Schema CodeGen Example Code Example 1 Example 2 Example 3 Customizations Reference Binding Definition Binding Tutorial A basic binding Binding extras Structure mapping Collections and arrays Using mappings Advanced binding Method hooks Custom code Precompiled Bindings Definition details Definition contexts Conversions XML summary <binding> element <include> element <format> element <namespace> element <mapping> element <value> element <structure> element <collection> element Attribute groups Usage API Runtime JavaDocs Subprojects Eclipse Plug-in Introduction Install Usage Axis2 Usage | ### Pre-Java 5 sample code The final customization example demonstrates several features, including the use of untyped collections and custom typesafe enumeration classes. The code used for this example is in the same source tree as that used for the previous examples, but in a different package (`org.jibx.starter2`). Here's a sample of this non-Java 5 code, again with only a few of the classes shown and most of the get/set access methods left out:
    /**
     * Order information.
     */
    public class Order
    {
        private long m_orderNumber;

        private Customer m_customer;

        /** Billing address information. */
        private Address m_billTo;

        private Shipping m_shipping;

        /** Shipping address information. If missing, the billing address is also used as the
         shipping address. */
        private Address m_shipTo;

        private List m_items;

        /** Date order was placed with server. */
        private Date m_orderDate;

        /** Date order was shipped. This will be <code>null</code> if the order has not
         yet shipped. */
        private Date m_shipDate;

        private Float total;

        public long getOrderNumber() {
            return m_orderNumber;
        }

        public void setOrderNumber(long orderId) {
            this.m_orderNumber = orderId;
        }
        ...
    }

    /**
     * Address information.
     */
    public class Address
    {
        /** First line of street information (required). */
        private String m_street1;

        /** Second line of street information (optional). */
        private String m_street2;

        private String m_city;

        /** State abbreviation (required for the U.S. and Canada, optional otherwise). */
        private String m_state;

        /** Postal code (required for the U.S. and Canada, optional otherwise). */
        private String m_postCode;

        /** Country name (optional, U.S. assumed if not supplied). */
        private String m_country;

        public String getStreet1() {
            return m_street1;
        }

        public void setStreet1(String street1) {
            this.m_street1 = street1;
        }
        ...
    }

    /**
     * Supported shipment methods. The "INTERNATIONAL" shipment methods can only be used for
     * orders with shipping addresses outside the U.S., and one of these methods is required
     * in this case.
     */
    public class Shipping
    {
        private static final List values = new ArrayList();

        public static final Shipping STANDARD_MAIL = new Shipping("STANDARD_MAIL");
        public static final Shipping PRIORITY_MAIL = new Shipping("PRIORITY_MAIL");
        public static final Shipping INTERNATIONAL_MAIL = new Shipping("INTERNATIONAL_MAIL");
        public static final Shipping DOMESTIC_EXPRESS = new Shipping("DOMESTIC_EXPRESS");
        public static final Shipping INTERNATIONAL_EXPRESS = new Shipping("INTERNATIONAL_EXPRESS");

        private String text;

        private Shipping(String text) {
            this.text = text;
            values.add(this);
        }

        public static Shipping fromString(String text) {
            for (Iterator iter = values.iterator(); iter.hasNext();) {
                Shipping value = (Shipping)iter.next();
                if (value.text.equals(text)) {
                    return value;
                }
            }
            throw new IllegalArgumentException("'" + text + " is not a legal value");
        }

        public String toString() {
            return text;
        }
    }
### Customizing individual values and more Here's custom3.xml, used by Example 4 with the above code:
    <custom namespace-style="fixed" namespace="http://www.jibx.org/starters/fromcode"
        force-mapping="true" strip-prefixes="m_">
      <package name="org.jibx.starter2">
        <class name="Address" requireds="street1 city"/>
        <class name="Customer" requireds="lastName firstName /customerNumber">
          <value field="m_middleNames" item-type="java.lang.String"/>
        </class>
        <class name="Item" excludes="description">
          <value get-method="getId" set-method="setId" attribute="id" required="true"/>
          <value property-name="quantity" attribute="quantity" required="true"/>
          <value field="m_price" required="true"/>
        </class>
        <class name="Order" requireds="orderNumber customer billTo shipping orderDate">
          <value field="m_items" item-type="org.jibx.starter2.Item"/>
        </class>
        <class name="Shipping" form="simple"
            deserializer="org.jibx.starter2.Shipping.fromString"/>
      </package>
    </custom>
The `force-mapping="true"` attribute on the root 'custom' element modifies the structure of the generated binding and schema. This customization tells BindGen to create a separate schema complexType and corresponding abstract mapping definition for each class in the binding with any child elements or attributes (rather than taking the default approach of inlining those which are only used once). The `strip-prefixes="m_"` customization tells BindGen to strip off any 'm_' prefix on field names (there's also a 'strip-suffixes' customization, and both of these take a space-separated list of possible prefixes/suffixes rather than just a single text). The last nested 'class' element, for the 'Shipping' class, uses a pair of attributes to control how BindGen works with this class. The first attribute, `form="simple"`, says that instances of the class are to be represented in XML documents as a simple text string, which can take the form of either an attribute value or the content of an element. The second attribute, `deserializer="org.jibx.starter2.Shipping.fromString"`, tells BindGen to use the specified static static method to convert a text value into an instance of the class. This is necessary because the class implements a type-safe enumeration, and the existing instance for a particular value needs to be returned rather than a new instance. If the class implemented a constructor taking a single `String` argument that would be used by default. You can also use a 'serializer' attribute for a simple value class to tell BindGen how to get the text value for an instance of the class; by default, it just uses the `toString()` method value. The other differences from the Example 3 customizations are in the details for three of the class customizations. The 'Customer' and 'Order' class customizations each contain a nested 'value' customization element referencing a field of type `java.util.List`. The 'item-type' attributes on these nested elements tell BindGen what types of values are present in each list, information which was available directly from the typed generics in the Java 5 version of the code. The 'Item' class customization also includes nested 'value' elements, in this case replacing the 'requireds' attribute used in the earlier customizations (so each nested value uses `required="true"`). These three value elements demonstrate all three different ways of referencing a particular value within a class: The first uses 'get-method' and 'set-method' attributes, the second uses a 'property-name' attribute, and the third uses a 'field' attribute. The first two of these elements also include 'attribute' attributes, each giving the name for the corresponding value to be represented as an attribute in XML documents (if you wanted to instead represent a value as an element, you'd use an 'element' attribute to specify the name). The third value customization, for the 'm_price' field, does not specify a representation and name, so the default representation and name (as an attribute named 'price') is used for that value. ### Generated schema You can try out the above customization by again using the Ant 'compile' target to compile the sample code, followed by the 'custgen3' target to run BindGen using the above customizations. Here's the resulting schema (again with the longer lines split):
    <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
        xmlns:tns="http://www.jibx.org/starters/fromcode" elementFormDefault="qualified"
        targetNamespace="http://www.jibx.org/starters/fromcode">
      <xs:complexType name="customer">
        <xs:annotation>
          <xs:documentation>Customer information.</xs:documentation>
        </xs:annotation>
        <xs:sequence>
          <xs:element type="xs:string" name="lastName">
            <xs:annotation>
              <xs:documentation>Family name.</xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element type="xs:string" name="firstName">
            <xs:annotation>
              <xs:documentation>Personal name.</xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element type="xs:long" name="customerNumber"/>
          <xs:element type="xs:string" name="middleName" minOccurs="0"
              maxOccurs="unbounded"/>
        </xs:sequence>
      </xs:complexType>
      <xs:complexType name="item">
        <xs:annotation>
          <xs:documentation>Order line item information.</xs:documentation>
        </xs:annotation>
        <xs:sequence/>
        <xs:attribute type="xs:string" use="required" name="id">
          <xs:annotation>
            <xs:documentation>Stock identifier. This is expected to be 12 characters in length, with
            two leading alpha characters followed by ten decimal digits.</xs:documentation>
          </xs:annotation>
        </xs:attribute>
        <xs:attribute type="xs:int" use="required" name="quantity">
          <xs:annotation>
            <xs:documentation>Number of units ordered.</xs:documentation>
          </xs:annotation>
        </xs:attribute>
        <xs:attribute type="xs:float" use="required" name="price">
          <xs:annotation>
            <xs:documentation>Price per unit.</xs:documentation>
          </xs:annotation>
        </xs:attribute>
      </xs:complexType>
      <xs:element type="tns:order" name="order"/>
      <xs:complexType name="address">
        <xs:annotation>
          <xs:documentation>Address information.</xs:documentation>
        </xs:annotation>
        <xs:sequence>
          <xs:element type="xs:string" name="street1">
            <xs:annotation>
              <xs:documentation>First line of street information (required).</xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element type="xs:string" name="city"/>
          <xs:element type="xs:string" name="street2" minOccurs="0">
            <xs:annotation>
              <xs:documentation>Second line of street information (optional).</xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element type="xs:string" name="state" minOccurs="0">
            <xs:annotation>
              <xs:documentation>State abbreviation (required for the U.S. and Canada, optional
              otherwise).</xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element type="xs:string" name="postCode" minOccurs="0">
            <xs:annotation>
              <xs:documentation>Postal code (required for the U.S. and Canada, optional
              otherwise).</xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element type="xs:string" name="country" minOccurs="0">
            <xs:annotation>
              <xs:documentation>Country name (optional, U.S. assumed if not
              supplied).</xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:sequence>
      </xs:complexType>
      <xs:complexType name="order">
        <xs:annotation>
          <xs:documentation>Order information.</xs:documentation>
        </xs:annotation>
        <xs:sequence>
          <xs:element type="tns:customer" name="customer"/>
          <xs:element type="tns:address" name="billTo">
            <xs:annotation>
              <xs:documentation>Billing address information.</xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element type="xs:string" name="shipping"/>
          <xs:element type="tns:address" name="shipTo" minOccurs="0">
            <xs:annotation>
              <xs:documentation>Shipping address information. If missing, the billing address is
              also used as the shipping address.</xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element type="tns:item" name="item" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
        <xs:attribute type="xs:long" use="required" name="orderNumber"/>
        <xs:attribute type="xs:date" use="required" name="orderDate">
          <xs:annotation>
            <xs:documentation>Date order was placed with server.</xs:documentation>
          </xs:annotation>
        </xs:attribute>
        <xs:attribute type="xs:date" name="shipDate">
          <xs:annotation>
            <xs:documentation><![CDATA[Date order was shipped. This will be <code>null</code>
            if the order has not yet shipped.]]></xs:documentation>
          </xs:annotation>
        </xs:attribute>
        <xs:attribute type="xs:float" name="total"/>
      </xs:complexType>
    </xs:schema>
The only significant changes to the schema from the last example are that the formerly-embedded complexTypes representing 'Item' and 'Customer' data are now global complexTypes (as requested by the `force-mapping="true"` customization), and the actual enumeration of 'Shipping' values is missing. This latter difference is a limitation of the current code for handling non-Java 5 enumerations, which does not support a way of accessing the possible enumeration values. Support for accessing the possible values will be added in a future release. ### Testing the binding Since the actual XML structure has not changed from the last example, the same test document as last time can be used with this example. Once you've run the Ant 'compile', 'custgen3', and 'bind' targets you can test the generated binding using 'run-alt1' (which runs the test program in the `org.jibx.starter2` package with data2.xml as input and out2.xml as output). You can also try out the full 'compile', 'custgen3', 'bind', and 'run-alt' sequence by using the Ant target 'custom3'.