Java Sample : Simple Sequence
In This Topic
Java Sample : Simple Sequence
| Schema Summary This sample shows an element containing a sequence of simple elements and attributes. Schema Details The Element DVD contains a sequence of simple elements (simple because they are represented by primitives). All of these elements are required, and they must appear in the correct order. In addition the DVD element contains 2 attributes Genre and Cost. Genre is optional, Cost is Mandatory. Because Genre is optional, and contains primitive data, an IsValidGenre method is added to the generated DVD object. This allows you to determine if Genre was set or not. The generated classes take car of outputting the child elements in the correct order. Sample Description The sample demonstrates the element with all of the optional elements present. Note Genre is an optional primitive, so we should check it using the IsValid flag before accessing it |
Sample XML File
  Sample2.xml |
<?xml version="1.0" encoding="UTF-8"?>
<DVD xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="..\Schema\SimpleSequence.xsd" Cost="12.99" Genre="Horror">
<Title>From Hell</Title>
<Description>A film about Jack the Ripper</Description>
<ReleaseDate>2001-08-15</ReleaseDate>
</DVD>
|
Sample Code
| Read Sample |
|
public static void SampleRead(String FilePath) throws Exception
{
// Create DVD object
SimpleSequenceLib.DVD dvd = new SimpleSequenceLib.DVD();
// Load data into the object from a file
dvd.fromXmlFile(FilePath);
// Now we can look at the data
System.out.println("DVD Title = " + dvd.getTitle());
System.out.println("DVD Description = " + dvd.getDescription());
System.out.println("DVD Release Date = " + dvd.getReleaseDate().toString());
System.out.println("DVD Cost = " + dvd.getCost());
if (dvd.isValidGenre())
System.out.println("DVD Genre = " + dvd.getGenre());
}
SampleRead(Usage1.SamplePath + "SimpleSequence\\Samples\\Sample2.xml");
|
| Write Sample |
|
// Create DVD object
SimpleSequenceLib.DVD dvd = new SimpleSequenceLib.DVD();
// Now we can look at the data
dvd.setTitle("From Hell");
dvd.setDescription("A film about Jack the Ripper");
dvd.getReleaseDate().setDate((short)2001, (byte)9, (byte)15);
dvd.setCost(12.99);
dvd.setGenre("Horror");
// Now we can look at the XML from this object
System.out.println(dvd.toXml(true, Formatting.INDENTED, Encoding.UTF8, EOLType.CRLF));
|
XSD Source Files
| SimpleSequence.xsd |
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:element name="DVD">
<xs:complexType>
<xs:sequence>
<xs:element name="Title" type="xs:string"/>
<xs:element name="Description" type="xs:string"/>
<xs:element name="ReleaseDate" type="xs:date"/>
</xs:sequence>
<xs:attribute name="Genre" type="xs:string" use="optional"/>
<xs:attribute name="Cost" type="xs:double" use="required"/>
</xs:complexType>
</xs:element>
</xs:schema>
|
| Schema Diagrams |
 |
Generated Files
| DVD.java |
package SimpleSequenceLib;
/**********************************************************************************************
* Copyright (c) 2001-2023 Liquid Technologies Limited. All rights reserved.
* See www.liquid-technologies.com for product details.
*
* Please see products End User License Agreement for distribution permissions.
*
* WARNING: THIS FILE IS GENERATED
* Changes made outside of ##HAND_CODED_BLOCK_START blocks will be overwritten
*
* Generation : by Liquid XML Data Binder 19.0.14.11049
* Using Schema: SimpleSequence.xsd
**********************************************************************************************/
// <summary>
// This class represents the Element DVD
// </summary>
public class DVD extends com.liquid_technologies.ltxmllib20.XmlGeneratedClass {
private static final long serialVersionUID = 13L;
// <summary>
// Constructor for DVD
// </summary>
// <remarks>
// The class is created with all the mandatory fields populated with the
// default data.
// All Collection object are created.
// However any 1-n relationships (these are represented as collections) are
// empty. To comply with the schema these must be populated before the xml
// obtained from ToXml is valid against the schema SimpleSequence.xsd
// </remarks>
public DVD() {
setElementName("DVD");
init();
}
public DVD(String elementName) {
setElementName(elementName);
init();
}
// <summary>
// Initializes the class
// </summary>
// <remarks>
// This creates all the mandatory fields (populated with the default data)
// All Collection object are created.
// However any 1-n relationships (these are represented as collections) are
// empty. To comply with the schema these must be populated before the xml
// obtained from ToXml is valid against the schema SimpleSequence.xsd.
// </remarks>
@Override
protected void init() {
try {
SimpleSequenceLib.Registration.iRegistrationIndicator = 0; // causes registration to take place
_genre = "";
_isValidGenre = false;
_cost = 0;
_title = "";
_description = "";
_releaseDate = new com.liquid_technologies.ltxmllib20.DateTime(com.liquid_technologies.ltxmllib20.DateTimeType.date);
// ##HAND_CODED_BLOCK_START ID="Additional Inits"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
// Add Additional initialization code here...
// ##HAND_CODED_BLOCK_END ID="Additional Inits"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
getClassAttributeInfo();
getClassElementInfo();
} catch (Exception ex) {
// should never happen
ex.printStackTrace();
throw new InternalError();
}
}
// <summary>
// Allows the class to be copied
// </summary>
// <remarks>
// Performs a 'deep copy' of all the data in the class (and its children)
// </remarks>
@Override
public Object clone() throws CloneNotSupportedException {
try {
SimpleSequenceLib.DVD newObject = (SimpleSequenceLib.DVD)super.clone();
// clone, creates a bitwise copy of the class, so all the collections are the
// same as the parents. Init will re-create our own collections, and classes,
// preventing objects being shared between the new an original objects
newObject.init();
if (_isValidGenre)
newObject._genre = _genre;
newObject._isValidGenre = _isValidGenre;
newObject._cost = _cost;
newObject._title = _title;
newObject._description = _description;
newObject._releaseDate = (com.liquid_technologies.ltxmllib20.DateTime)_releaseDate.clone();
// ##HAND_CODED_BLOCK_START ID="Additional clone"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
// Add Additional clone code here...
// ##HAND_CODED_BLOCK_END ID="Additional clone"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
return newObject;
} catch (CloneNotSupportedException e) {
// should never happen
e.printStackTrace();
throw new InternalError();
}
}
@Override
public String getTargetNamespace() {
return "";
}
// <summary>
// Represents an optional Attribute in the XML document
// </summary>
// <remarks>
// This property is represented as an Attribute in the XML.
// It is optional, initially it is not valid.
// </remarks>
public java.lang.String getGenre() throws com.liquid_technologies.ltxmllib20.exceptions.LtException {
if (_isValidGenre == false)
throw new com.liquid_technologies.ltxmllib20.exceptions.LtInvalidStateException("The Property Genre is not valid. Set GenreValid = true");
return _genre;
}
public void setGenre(java.lang.String value) throws com.liquid_technologies.ltxmllib20.exceptions.LtException {
// Apply whitespace rules appropriately
value = com.liquid_technologies.ltxmllib20.WhitespaceUtils.preserve(value);
_isValidGenre = true;
_genre = value;
}
// <summary>
// Indicates if Genre contains a valid value.
// </summary>
// <remarks>
// true if the value for Genre is valid, false if not.
// If this is set to true then the property is considered valid, and assigned its
// default value ("").
// If its set to false then its made invalid, and subsequent calls to get Genre
// will raise an exception.
// </remarks>
public boolean isValidGenre() {
return _isValidGenre;
}
public void setValidGenre(boolean value) throws com.liquid_technologies.ltxmllib20.exceptions.LtException {
if (value != _isValidGenre) {
_genre = "";
_isValidGenre = value;
}
}
protected boolean _isValidGenre;
protected java.lang.String _genre;
// <summary>
// Represents a mandatory Attribute in the XML document
// </summary>
// <remarks>
// This property is represented as an Attribute in the XML.
// It is mandatory and therefore must be populated within the XML.
// It is defaulted to 0.
// </remarks>
public double getCost() throws com.liquid_technologies.ltxmllib20.exceptions.LtException {
return _cost;
}
public void setCost(double value) throws com.liquid_technologies.ltxmllib20.exceptions.LtException {
_cost = value;
}
protected double _cost;
// <summary>
// Represents a mandatory Element in the XML document
// </summary>
// <remarks>
// This property is represented as an Element in the XML.
// It is mandatory and therefore must be populated within the XML.
// It is defaulted to "".
// </remarks>
public java.lang.String getTitle() throws com.liquid_technologies.ltxmllib20.exceptions.LtException {
return _title;
}
public void setTitle(java.lang.String value) throws com.liquid_technologies.ltxmllib20.exceptions.LtException {
// Apply whitespace rules appropriately
value = com.liquid_technologies.ltxmllib20.WhitespaceUtils.preserve(value);
_title = value;
}
protected java.lang.String _title;
// <summary>
// Represents a mandatory Element in the XML document
// </summary>
// <remarks>
// This property is represented as an Element in the XML.
// It is mandatory and therefore must be populated within the XML.
// It is defaulted to "".
// </remarks>
public java.lang.String getDescription() throws com.liquid_technologies.ltxmllib20.exceptions.LtException {
return _description;
}
public void setDescription(java.lang.String value) throws com.liquid_technologies.ltxmllib20.exceptions.LtException {
// Apply whitespace rules appropriately
value = com.liquid_technologies.ltxmllib20.WhitespaceUtils.preserve(value);
_description = value;
}
protected java.lang.String _description;
// <summary>
// Represents a mandatory Element in the XML document
// </summary>
// <remarks>
// This property is represented as an Element in the XML.
// It is mandatory and therefore must be populated within the XML.
// It is defaulted to new com.liquid_technologies.ltxmllib20.DateTime(com.liquid_technologies.ltxmllib20.DateTimeType.date).
// </remarks>
public com.liquid_technologies.ltxmllib20.DateTime getReleaseDate() throws com.liquid_technologies.ltxmllib20.exceptions.LtException {
return _releaseDate;
}
public void setReleaseDate(com.liquid_technologies.ltxmllib20.DateTime value) throws com.liquid_technologies.ltxmllib20.exceptions.LtException {
_releaseDate.setDateTime(value, _releaseDate.getType());
}
protected com.liquid_technologies.ltxmllib20.DateTime _releaseDate;
@Override
public String getNamespace() {
return "";
}
@Override
public com.liquid_technologies.ltxmllib20.XmlObjectBase getBase() {
return this;
}
protected void onEvent(com.liquid_technologies.ltxmllib20.XmlObjectBase msgSource, int msgType, Object data) {
if (msgType == CollectionChangeEvent) {
}
}
private static com.liquid_technologies.ltxmllib20.ParentElementInfo __parentElementInfo = null;
private static com.liquid_technologies.ltxmllib20.ElementInfo[] __elementInfo = null;
private static com.liquid_technologies.ltxmllib20.AttributeInfo[] __attributeInfo = null;
protected com.liquid_technologies.ltxmllib20.ParentElementInfo getClassInfo() throws Exception {
if (__parentElementInfo == null) {
__parentElementInfo = new com.liquid_technologies.ltxmllib20.ParentElementInfo(
com.liquid_technologies.ltxmllib20.XmlObjectBase.XmlElementGroupType.SEQUENCE,
com.liquid_technologies.ltxmllib20.XmlObjectBase.XmlElementType.ELEMENT, "DVD", "", true, false,
null, null, com.liquid_technologies.ltxmllib20.Conversions.ConversionType.TYPE_NONE, com.liquid_technologies.ltxmllib20.WhitespaceRule.NONE, null, false);
}
return __parentElementInfo;
}
protected com.liquid_technologies.ltxmllib20.ElementInfo[] getClassElementInfo() throws Exception {
if (__elementInfo == null) {
__elementInfo = new com.liquid_technologies.ltxmllib20.ElementInfo[] {
new com.liquid_technologies.ltxmllib20.data.ElementInfoSeqPrimMnd("Title", "", findGetterMethod("SimpleSequenceLib.DVD", "getTitle"), findSetterMethod("SimpleSequenceLib.DVD", "setTitle", "java.lang.String"), null, null, com.liquid_technologies.ltxmllib20.Conversions.ConversionType.TYPE_STRING, null, com.liquid_technologies.ltxmllib20.WhitespaceRule.PRESERVE, new com.liquid_technologies.ltxmllib20.PrimitiveRestrictions("", -1, -1, "", "", "", "", -1, -1, -1), null)
,new com.liquid_technologies.ltxmllib20.data.ElementInfoSeqPrimMnd("Description", "", findGetterMethod("SimpleSequenceLib.DVD", "getDescription"), findSetterMethod("SimpleSequenceLib.DVD", "setDescription", "java.lang.String"), null, null, com.liquid_technologies.ltxmllib20.Conversions.ConversionType.TYPE_STRING, null, com.liquid_technologies.ltxmllib20.WhitespaceRule.PRESERVE, new com.liquid_technologies.ltxmllib20.PrimitiveRestrictions("", -1, -1, "", "", "", "", -1, -1, -1), null)
,new com.liquid_technologies.ltxmllib20.data.ElementInfoSeqPrimMnd("ReleaseDate", "", findGetterMethod("SimpleSequenceLib.DVD", "getReleaseDate"), findSetterMethod("SimpleSequenceLib.DVD", "setReleaseDate", "com.liquid_technologies.ltxmllib20.DateTime"), null, null, com.liquid_technologies.ltxmllib20.Conversions.ConversionType.TYPE_DATE, null, com.liquid_technologies.ltxmllib20.WhitespaceRule.COLLAPSE, new com.liquid_technologies.ltxmllib20.PrimitiveRestrictions("", -1, -1, "", "", "", "", -1, -1, -1), null)
};
}
return __elementInfo;
}
protected com.liquid_technologies.ltxmllib20.AttributeInfo[] getClassAttributeInfo() throws Exception {
if (__attributeInfo==null) {
__attributeInfo = new com.liquid_technologies.ltxmllib20.AttributeInfo[] {
new com.liquid_technologies.ltxmllib20.AttributeInfoPrimitive("Genre", "", findGetterMethod("SimpleSequenceLib.DVD", "getGenre"), findSetterMethod("SimpleSequenceLib.DVD", "setGenre", "java.lang.String"), findGetterMethod("SimpleSequenceLib.DVD", "isValidGenre"), com.liquid_technologies.ltxmllib20.Conversions.ConversionType.TYPE_STRING, null, com.liquid_technologies.ltxmllib20.WhitespaceRule.PRESERVE, new com.liquid_technologies.ltxmllib20.PrimitiveRestrictions("", -1, -1, "", "", "", "", -1, -1, -1), null)
,new com.liquid_technologies.ltxmllib20.AttributeInfoPrimitive("Cost", "", findGetterMethod("SimpleSequenceLib.DVD", "getCost"), findSetterMethod("SimpleSequenceLib.DVD", "setCost", "double"), com.liquid_technologies.ltxmllib20.Conversions.ConversionType.TYPE_R8, null, com.liquid_technologies.ltxmllib20.WhitespaceRule.COLLAPSE, new com.liquid_technologies.ltxmllib20.PrimitiveRestrictions("", -1, -1, "", "", "", "", -1, -1, -1), null)
};
}
return __attributeInfo;
}
// ##HAND_CODED_BLOCK_START ID="Additional Methods"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
// Add Additional Methods and members here...
// ##HAND_CODED_BLOCK_END ID="Additional Methods"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
}
|
| Main Menu | Samples List |