Copyright © Cloud Software Group, Inc. All Rights Reserved

Java To XML

Activity

The Java To XML activity allows you to convert a Java object’s data members into an XML document. See Java Schema for the conversion rules.

If the class does not have a public data member and only has a Java bean modifier that sets the data, the input schema contains an element for the modifier, but the resulting XML document has no value set for the corresponding element. For example, the Java object has a method declared as public int setID(), but there is no method for getting the ID, and the data member ID is not public. In this case, there is an element named ID in this activity’s output schema, but that element has no value because there is no public mechanism for getting the data.

Enumeration

Java enum type elements can be mapped to a simple type schema with enumeration facets. You can use the following annotations in your Java classes to use Java enums :

•	javax.xml.bind.annotation.XmlEnum

•	javax.xml.bind.annotation.XmlEnumValue

XmlEnum and XmlEnumValue together provide a mapping of type enum to the XML representation.

For more details and for the usage of these annotations, see, https://jaxb.java.net/nonav/2.2.4/docs/api/javax/xml/bind/annotation/XmlEnum.html

and https://jaxb.java.net/nonav/2.2.4/docs/api/javax/xml/bind/annotation/XmlEnumValue.html

 

Table 4 Java to Schema Data Type Binding

Field	Description
xsd:string	java.lang.String
xsd:boolean	java.lang.Boolean
xsd.byte	java.lang.Byte
xsd:short	java.lang.Boolean
xsd:int	java.lang.Integer
xsd:long	java.lang.Long

Example 1

 

@XmlEnum(String.class)

public enum Card { CLUBS, DIAMONDS, HEARTS, SPADES }

<xs:simpleType name="Card">

<xs:restriction base="xs:string"/>

<xs:enumeration value="CLUBS"/>

<xs:enumeration value="DIAMONDS"/>

<xs:enumeration value="HEARTS"/>

<xs:enumeration value="SPADES"/>

</xs:simpleType>

 

Example 2

 

@XmlEnum(Integer.class)

public enum Coin {

@XmlEnumValue("1") PENNY(1),

@XmlEnumValue("5") NICKEL(5),

@XmlEnumValue("10") DIME(10),

@XmlEnumValue("25") QUARTER(25) }

 

<!-- Example: XML Schema fragment -->

<xs:simpleType name="Coin">

<xs:restriction base="xs:int">

<xs:enumeration value="1"/>

<xs:enumeration value="5"/>

<xs:enumeration value="10"/>

<xs:enumeration value="25"/>

</xs:restriction>

</xs:simpleType>

Sequenced Elements

For a Java schema to generate the schema of complex type element having a sequence order indicator in the right sequence, use XMLType annotations in the Java classes.

This change in behavior is enabled by a system property java.property.com.tibco.xml.conversion.SequencingViaAnnotation=true.

BusinessWorks tries to get the order of the element through annotations when the property is set to true. The default value is false.

Use the following annotation:

javax.xml.bind.annotation.XmlType

Properties and fields mapped to elements are mapped to a content model within a complex type.

The annotation element propOrder() can be used to customize content model to xs:sequence. This is used to specify the order of the XML elements in xs:sequence.

For example, map a class to a complex type element with xs:sequence with a customized ordering of JavaBean properties.

 

@XmlType(propOrder={"street", "city" , "state", "zip", "name" })

public class USAddress {

private String name;

private String street;

private String city;

private String state;

private long zip;

public String getName() {..};

public void setName(String) {..};

public String getStreet() {..};

public void setStreet(String) {..};

 

public String getCity() {..};

public void setCity(String) {..};

public String getState() {..};

public void setState(String) {..};

 

public long getZip() {..};

public void setZip(long zip) {..};

}

 

<!-- XML Schema mapping for USAddress -->

<xs:complexType name="USAddress">

<xs:sequence>

<xs:element name="street" type="xs:string"/>

<xs:element name="city" type="xs:string"/>

<xs:element name="state" type="xs:string"/>

<xs:element name="zip" type="xs:decimal"/>

<xs:element name="name" type="xs:string"/>

</xs:sequence>

</xs:complexType>

 

An exception is thrown if any of the following conditions are true:

a.	All the field members are not specified in the proporder element. Or,

b.	proporder contains the name of a field member that does not exist.

 

Configuration

The Configuration tab has the following fields.

XML Schema Type	Global Var?	Java Data Type
Name	No	The name to appear as the label for the resource.
Description	No	Short description of the activity.
Use Java Schema		Specifies whether you want to use a Java Schema shared configuration resource to configure this activity or whether you want to specify a Java class file. When unchecked, the Java Class field appears. When checked, the Java Schema: and Class: fields appear.
Java Schema:	No	Only available when the Use Java Schema field is checked. This field specifies a Java Schema shared configuration resource. This resource is used to specify the schema used to convert the Java object to the XML schema.
Java Class:		When Use Java Schema is checked, this is the class in the Java Schema to use. Use the Show Class Browser button to bring up the dialog to choose th Java class.

Advanced

The Advanced tab has the following fields:.

Field	Global Var?	Description
Construct Declared Class	No	This field controls whether the declaring class must be constructed when the activity is executed or whether an object reference must be supplied in the activity’s input schema. When this field is checked, the declaring class is constructed using the default constructor when the activity executes. In this case, the declaring class is not included in the activity’s input schema. When this field is unchecked, you must supply an object reference for the Java Class specified on the Configuration tab. The object must be created and contained in the output schema of a previously executed activity, such as a Java Code activity, Java Method, or an XML To Java activity. In this case, the declaring class is included in the activity’s input schema.
Cache Constructed Class	No	This field is only available when Construct Declared Class is checked. When checked, this specifies that all instances of this Java To XML activity share the instance of the constructed declaring class. If the constructed object is cached, it is kept in memory until the process engine terminates. If this field is unchecked, each instance of this Java To XML activity creates its own copy of the declaring class. See Caching the Java Class for more information about caching the declared class.

Input

See TIBCO ActiveMatrix BusinessWorks Process Design for more information about mapping and transforming input data.

The input for the activity is the following.

Input Item	Datatype	Description
<declaringClass>	Java Object	An object reference to the Java Class specified on the Configuration tab. This element is only available when the Construct Declared Class field on the Advanced tab is unchecked.

Output

The output for the activity is the following.

Output Item	Datatype	Description
XML Schema	varies	The XML schema from the converted Java object is output. The elements appear in the schema in alphabetical order.

Error Output

The Error Output tab lists the possible exceptions that can be thrown by this activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information about error codes and corrective action to take.

Exception	Thrown When...
JavaToXMLConversionException	An error occurred when converting the Java object to XML.

Copyright © Cloud Software Group, Inc. All Rights Reserved