org.exolab.castor.builder.types

Class XSId

java.lang.Object

org.exolab.castor.builder.types.XSType

org.exolab.castor.builder.types.AbstractPatternFacet

org.exolab.castor.builder.types.AbstractWhiteSpaceFacet

org.exolab.castor.builder.types.AbstractLengthFacet

org.exolab.castor.builder.types.XSId

public final class XSId
extends AbstractLengthFacet

The xsd:ID XML Schema type.

Version:

$Revision: 6907 $ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $

Author:

Keith Visco, Ralf Joachim

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Name of this XSType.
static short	TYPE Type number of this XSType.

Fields inherited from class org.exolab.castor.builder.types.XSType

ANYURI_TYPE, BASE64BINARY_TYPE, BOOLEAN_TYPE, BYTE_TYPE, CLASS, COLLECTION, DATE_TYPE, DATETIME_TYPE, DECIMAL_TYPE, DOUBLE_TYPE, DURATION_TYPE, ENTITIES, ENTITY, FLOAT_TYPE, GDAY_TYPE, GMONTH_TYPE, GMONTHDAY_TYPE, GYEAR_TYPE, GYEARMONTH_TYPE, HEXBINARY_TYPE, ID_TYPE, IDREF_TYPE, IDREFS_TYPE, INT_TYPE, INTEGER_TYPE, LANGUAGE_TYPE, LONG_TYPE, NAME_TYPE, NCNAME_TYPE, NEGATIVE_INTEGER_TYPE, NMTOKEN_TYPE, NMTOKENS_TYPE, NON_NEGATIVE_INTEGER_TYPE, NON_POSITIVE_INTEGER_TYPE, NORMALIZEDSTRING_TYPE, NOTATION_TYPE, NULL, POSITIVE_INTEGER_TYPE, QNAME_TYPE, SHORT_TYPE, STRING_TYPE, TIME_TYPE, TOKEN_TYPE, UNSIGNED_BYTE_TYPE, UNSIGNED_INT_TYPE, UNSIGNED_LONG_TYPE, UNSIGNED_SHORT_TYPE

Constructor Summary

Constructors

Constructor and Description
XSId()

Method Summary

Methods

Modifier and Type	Method and Description
String	createFromJavaObjectCode(String variableName) Returns the string necessary to convert an Object to an instance of this XSType.
String	createToJavaObjectCode(String variableName) Returns the string necessary to convert an instance of this XSType to an Object.
JType	getJType() Returns the JType that this XSType represents.
String	getName() Returns the name of this XSType.
short	getType() Returns the type of this XSType.
boolean	isDateTime() Returns true if the XSType represents an XML Schema date/time type.
boolean	isPrimitive() Returns true if this XSType represents a primitive type.
String	newInstanceCode() Returns the Java code neccessary to create a new instance of the JType associated with this XSType.
void	validationCode(JSourceCode jsc, String fixedValue, String validatorInstanceName) Creates the validation code for an instance of this XSType.

Methods inherited from class org.exolab.castor.builder.types.AbstractLengthFacet

codeLengthFacet, getLength, getMaxLength, getMinLength, hasLength, hasMaxLength, hasMinLength, setFacet, setLength, setLengthFacet, setMaxLength, setMinLength

Methods inherited from class org.exolab.castor.builder.types.AbstractWhiteSpaceFacet

codeWhiteSpaceFacet, getWhiteSpace, hasWhiteSpace, setWhiteSpace, setWhiteSpaceFacet

Methods inherited from class org.exolab.castor.builder.types.AbstractPatternFacet

addPattern, addPatternFacet, codePatternFacet, getPatterns

Methods inherited from class org.exolab.castor.builder.types.XSType

createDefaultValueWithString, isCollection, isEnumerated, setAsEnumerated, setFacets

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Name of this XSType.

See Also:

Constant Field Values

TYPE

public static final short TYPE

Type number of this XSType.

See Also:

Constant Field Values

Constructor Detail

XSId

public XSId()

Method Detail

getName

public String getName()

Returns the name of this XSType.

Specified by:

getName in class XSType

Returns:

The name of this XSType.

getType

public short getType()

Returns the type of this XSType.

Specified by:

getType in class XSType

Returns:

the type of this XSType.

isPrimitive

public boolean isPrimitive()

Returns true if this XSType represents a primitive type.

Specified by:

isPrimitive in class XSType

Returns:

True if this XSType represents a primitive type.

isDateTime

public boolean isDateTime()

Returns true if the XSType represents an XML Schema date/time type.

Specified by:

isDateTime in class XSType

Returns:

True if the XSType represents an XML Schema date/time type.

getJType

public JType getJType()

Returns the JType that this XSType represents.

Specified by:

getJType in class XSType

Returns:

The JType that this XSType represents.

newInstanceCode

public String newInstanceCode()

Returns the Java code neccessary to create a new instance of the JType associated with this XSType.

Specified by:

newInstanceCode in class XSType

Returns:

The Java code neccessary to create a new instance.

createToJavaObjectCode

public String createToJavaObjectCode(String variableName)

Returns the string necessary to convert an instance of this XSType to an Object. This method is really only useful for primitive types.

Specified by:

createToJavaObjectCode in class XSType

Parameters:

variableName - The name of the instance variable.

Returns:

The String necessary to convert an instance of this XSType to an Object.

createFromJavaObjectCode

public String createFromJavaObjectCode(String variableName)

Returns the string necessary to convert an Object to an instance of this XSType. This method is really only useful for primitive types.

Specified by:

createFromJavaObjectCode in class XSType

Parameters:

variableName - The name of the Object.

Returns:

The String necessary to convert an Object to an instance of this XSType.

validationCode

public void validationCode(JSourceCode jsc,
                  String fixedValue,
                  String validatorInstanceName)

Creates the validation code for an instance of this XSType. If necessary the validation code should create a newly configured TypeValidator, that should then be added to a FieldValidator instance whose name is provided.

Specified by:

validationCode in class XSType

Parameters:

jsc - The JSourceCode to fill in.

fixedValue - A fixed value to use if any.

validatorInstanceName - The name of the FieldValidator that the configured TypeValidator should be added to.