nilus

Class Helper

java.lang.Object

nilus.Helper

public class Helper
extends Object

Class for creating required elements of a schema

Author:

mroch

Field Summary

Fields

Modifier and Type	Field and Description
protected MarshalXML	marshaller

Constructor Summary

Constructors

Constructor and Description
Helper()

Method Summary

Modifier and Type	Method and Description
Element	AddAnyElement(List<Element> ellist, String name, String value) Given an element list, adds a new element and value to the list
static void	createElement(Object o, String field) Create specified element within a JAXB schema representation Any of the elements children that are required will also be created
static void	createRequiredElements(Object o) Finds and creates required elements within an JAXB schema representation
private static boolean	hasDefaultConstructor(Class<?> a_class) Check if a class has a default constructor
static XMLGregorianCalendar	timestamp(BigInteger year, int month, int day, int hour, int minute, int second, BigDecimal fractionalSecond, int timezone) Create a timestamp object suitable for setting any XML field with a type of xs:DateTime Use of BigDecimal allows arbitrary precision for fractional seconds.
static XMLGregorianCalendar	timestamp(int year, int month, int day, int hour, int minute, int second, int millisecond, int timezone) Create a timestamp object suitable for setting any XML field with a type of xs:DateTime
static XMLGregorianCalendar	timestamp(String tstamp) Create a timestamp object suitable for setting any XML field with a type of xs:DateTime
static BigDecimal	toXsDecimal(double d) XML xs:decimal type is implemented in JAXB as a BigDecimal This routine converts a Java double to a big decimal
static Double	toXsDouble(double d) XML xs:double type is implemented in JAXB as a Double This routine converts a Java double to a Double
static BigInteger	toXsInteger(long n) XML xs:Integer type is implemented in JAXB as a BigInteger This routine converts a Java long to a BigInteger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

marshaller

protected MarshalXML marshaller

Constructor Detail

Helper

public Helper()
       throws JAXBException

Throws:

JAXBException

Method Detail

createRequiredElements

public static void createRequiredElements(Object o)
                                   throws IllegalArgumentException,
                                          IllegalAccessException,
                                          InstantiationException

Finds and creates required elements within an JAXB schema representation

Parameters:

o - Required elements will be created for this object

Throws:

IllegalArgumentException - illegal argument

IllegalAccessException - illegal access

InstantiationException - unable to instantiate

createElement

public static void createElement(Object o,
                                 String field)
                          throws IllegalArgumentException,
                                 IllegalAccessException,
                                 InstantiationException

Create specified element within a JAXB schema representation Any of the elements children that are required will also be created

Parameters:

o - Specified field will be created for this object

field - Name of field to create

Throws:

IllegalArgumentException - Bad argument

IllegalAccessException - Unable to access object

InstantiationException - Unable to instantiate

hasDefaultConstructor

private static boolean hasDefaultConstructor(Class<?> a_class)

Check if a class has a default constructor

Parameters:

a_class - Class to check

Returns:

True implies default constructor exists

timestamp

public static XMLGregorianCalendar timestamp(String tstamp)
                                      throws DatatypeConfigurationException

Create a timestamp object suitable for setting any XML field with a type of xs:DateTime

Parameters:

tstamp - - Must be in format (ISO 8601 subset): XML Schema 1.0 Part 2, Section 3.2.[7-14].1, Lexical Representation

Returns:

XMLGregorianCalendar

Throws:

DatatypeConfigurationException - problem with specified timestamp string

timestamp

public static XMLGregorianCalendar timestamp(int year,
                                             int month,
                                             int day,
                                             int hour,
                                             int minute,
                                             int second,
                                             int millisecond,
                                             int timezone)
                                      throws DatatypeConfigurationException

Create a timestamp object suitable for setting any XML field with a type of xs:DateTime

Parameters:

year - Year

month - Month

day - Day (numeric)

hour - Hour of day (24 hour clock)

minute - Minutes past hour

second - Seconds past minute

millisecond - Milliseconds past second

timezone - Offset in minutes from UTC

Returns:

XMLGregorianCalendar

Throws:

DatatypeConfigurationException - Problem with data input values

timestamp

public static XMLGregorianCalendar timestamp(BigInteger year,
                                             int month,
                                             int day,
                                             int hour,
                                             int minute,
                                             int second,
                                             BigDecimal fractionalSecond,
                                             int timezone)
                                      throws DatatypeConfigurationException

Create a timestamp object suitable for setting any XML field with a type of xs:DateTime Use of BigDecimal allows arbitrary precision for fractional seconds.

Parameters:

year - Year

month - Month (1-12)

day - Day of month number

hour - Hours into day

minute - Minutes into hour

second - Seconds into minute

fractionalSecond - Fractions of a second past second

timezone - Timezone offset (numeric)

Returns:

XMLGregorianCalendar

Throws:

DatatypeConfigurationException - Problem with time specification

AddAnyElement

public Element AddAnyElement(List<Element> ellist,
                             String name,
                             String value)
                      throws JAXBException,
                             ParserConfigurationException

Given an element list, adds a new element and value to the list

Parameters:

ellist - List to which we will add

name - Name of element to add

value - Value of element to add

Returns:

Throws:

ParserConfigurationException - Unable to parse

JAXBException - Problem creating element

toXsInteger

public static BigInteger toXsInteger(long n)

XML xs:Integer type is implemented in JAXB as a BigInteger This routine converts a Java long to a BigInteger

Parameters:

n - Integer to convert

Returns:

BigInteger

toXsDecimal

public static BigDecimal toXsDecimal(double d)

XML xs:decimal type is implemented in JAXB as a BigDecimal This routine converts a Java double to a big decimal

Parameters:

d - double value to convert

Returns:

BigDecimal (xs:decimal)

toXsDouble

public static Double toXsDouble(double d)

XML xs:double type is implemented in JAXB as a Double This routine converts a Java double to a Double

Parameters:

d - double value to convert

Returns:

Double object