org.apache.ws.jaxme.generator.sg

Interface PropertySG

All Known Implementing Classes:

PropertySGImpl

public interface PropertySG

Author:

Jochen Wiedmann

Method Summary

Methods

Modifier and Type	Method and Description
void	addValue(JavaMethod pMethod, DirectAccessible pElement, TypedValue pValue, JavaQName pType) Creates a piece of Java code adding an element value.
void	forAllNonNullValues(JavaMethod pMethod, DirectAccessible pElement, SGlet pSGlet) Invokes the given SGlet for any non null value.
void	forAllValues(JavaMethod pMethod, DirectAccessible pElement, SGlet pSGlet) Invokes the given SGlet for any value.
void	generate(JavaSource pSource) Generates the property setters and getters.
java.lang.String	getCollectionType() Returns the properties collection type.
java.lang.String	getPropertyName() Returns the objects property name.
java.lang.Object	getValue(DirectAccessible pElement) Returns a piece of Java code with the property value.
JavaField	getXMLField(JavaSource pSource) Creates the Java field holding the objects property value.
java.lang.String	getXMLFieldName() Returns the objects field name.
JavaMethod	getXMLGetMethod(JavaSource pSource) Creates the getter returning the property value.
java.lang.String	getXMLGetMethodName() Returns the objects getter name.
JavaMethod	getXMLIsSetMethod(JavaSource pSource) Creates the isSet returning whether the property value is set or not.
java.lang.String	getXMLIsSetMethodName() Returns the name of the objects "isSet" method.
JavaMethod	getXMLSetMethod(JavaSource pSource) Creates the setter returning the property value.
java.lang.String	getXMLSetMethodName() Returns the objects setter name.
boolean	hasIsSetMethod() Returns whether the property has an "is set" method.
void	init() Initializes the PropertySG.
void	setValue(JavaMethod pMethod, DirectAccessible pElement, java.lang.Object pValue, JavaQName pType) Creates a piece of Java code setting the elements property value.

Method Detail

init

void init()
          throws org.xml.sax.SAXException

Initializes the PropertySG.

Throws:

org.xml.sax.SAXException

hasIsSetMethod

boolean hasIsSetMethod()

Returns whether the property has an "is set" method.

getCollectionType

java.lang.String getCollectionType()

Returns the properties collection type.

getXMLFieldName

java.lang.String getXMLFieldName()
                                 throws org.xml.sax.SAXException

Returns the objects field name. By default, this is the property name with the prefix '_'.

Throws:

org.xml.sax.SAXException

getPropertyName

java.lang.String getPropertyName()
                                 throws org.xml.sax.SAXException

Returns the objects property name.

Throws:

org.xml.sax.SAXException

getXMLGetMethodName

java.lang.String getXMLGetMethodName()
                                     throws org.xml.sax.SAXException

Returns the objects getter name.

Throws:

org.xml.sax.SAXException

getXMLSetMethodName

java.lang.String getXMLSetMethodName()
                                     throws org.xml.sax.SAXException

Returns the objects setter name.

Throws:

org.xml.sax.SAXException

getXMLIsSetMethodName

java.lang.String getXMLIsSetMethodName()
                                       throws org.xml.sax.SAXException

Returns the name of the objects "isSet" method.

Throws:

org.xml.sax.SAXException

getXMLField

JavaField getXMLField(JavaSource pSource)
                      throws org.xml.sax.SAXException

Creates the Java field holding the objects property value.

Throws:

org.xml.sax.SAXException

getXMLGetMethod

JavaMethod getXMLGetMethod(JavaSource pSource)
                           throws org.xml.sax.SAXException

Creates the getter returning the property value.

Throws:

org.xml.sax.SAXException

getXMLSetMethod

JavaMethod getXMLSetMethod(JavaSource pSource)
                           throws org.xml.sax.SAXException

Creates the setter returning the property value.

Throws:

org.xml.sax.SAXException

getXMLIsSetMethod

JavaMethod getXMLIsSetMethod(JavaSource pSource)
                             throws org.xml.sax.SAXException

Creates the isSet returning whether the property value is set or not.

Throws:

org.xml.sax.SAXException

getValue

java.lang.Object getValue(DirectAccessible pElement)
                          throws org.xml.sax.SAXException

Returns a piece of Java code with the property value.

Parameters:

pElement - The element on which the value is being set or null for "this".

Throws:

org.xml.sax.SAXException

setValue

void setValue(JavaMethod pMethod,
            DirectAccessible pElement,
            java.lang.Object pValue,
            JavaQName pType)
              throws org.xml.sax.SAXException

Creates a piece of Java code setting the elements property value. In the case of an element with multiplicity > 1, the object must be a list or an array.

Parameters:

pMethod - The method being generated.

pElement - The element on which the value is being set or null for "this".

pType - The values type, if a cast is required, or null, if the value is already casted.

Throws:

org.xml.sax.SAXException

addValue

void addValue(JavaMethod pMethod,
            DirectAccessible pElement,
            TypedValue pValue,
            JavaQName pType)
              throws org.xml.sax.SAXException

Creates a piece of Java code adding an element value. In the case of an element with multiplicity > 1, the object must be the atomic value.

Parameters:

pElement - The element on which the value is being set or null for "this".

pType - The values type, if a cast is required, or null, if the value is already casted.

Throws:

org.xml.sax.SAXException

forAllValues

void forAllValues(JavaMethod pMethod,
                DirectAccessible pElement,
                SGlet pSGlet)
                  throws org.xml.sax.SAXException

Invokes the given SGlet for any value.

Parameters:

pElement - The element on which the value is being set or null for "this".

Throws:

org.xml.sax.SAXException

forAllNonNullValues

void forAllNonNullValues(JavaMethod pMethod,
                       DirectAccessible pElement,
                       SGlet pSGlet)
                         throws org.xml.sax.SAXException

Invokes the given SGlet for any non null value.

Parameters:

pElement - The element on which the value is being set or null for "this".

Throws:

org.xml.sax.SAXException

generate

void generate(JavaSource pSource)
              throws org.xml.sax.SAXException

Generates the property setters and getters.

Throws:

org.xml.sax.SAXException