Class AbstractPatternFacet

java.lang.Object

org.exolab.castor.builder.types.XSType

org.exolab.castor.builder.types.AbstractPatternFacet

Direct Known Subclasses:

AbstractWhiteSpaceFacet

public abstract class AbstractPatternFacet
extends XSType

A base class for types which support the pattern facet.

Since:

1.1

Version:

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

Author:

Keith Visco, Edward Kuns

Field Summary

Fields inherited from class 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

Modifier and Type	Field	Description
static final short	ANYURI_TYPE	xsd:anyURI.
static final short	BASE64BINARY_TYPE	xsd:base64Binary.
static final short	BOOLEAN_TYPE	xsd:boolean.
static final short	BYTE_TYPE	xsd:byte.
static final short	CLASS	A user-defined type.
static final short	COLLECTION	A collection type.
static final short	DATE_TYPE	xsd:date.
static final short	DATETIME_TYPE	xsd:dateTime.
static final short	DECIMAL_TYPE	xsd:decimal.
static final short	DOUBLE_TYPE	xsd:double.
static final short	DURATION_TYPE	xsd:duration.
static final short	ENTITIES	xsd:ENTITIES.
static final short	ENTITY	xsd:ENTITY.
static final short	FLOAT_TYPE	xsd:float.
static final short	GDAY_TYPE	xsd:gDay.
static final short	GMONTH_TYPE	xsd:gMonth.
static final short	GMONTHDAY_TYPE	xsd:gMonthDay.
static final short	GYEAR_TYPE	xsd:gYear.
static final short	GYEARMONTH_TYPE	xsd:gYearMonth.
static final short	HEXBINARY_TYPE	xsd:hexBinary.
static final short	ID_TYPE	xsd:ID.
static final short	IDREF_TYPE	xsd:IDREF.
static final short	IDREFS_TYPE	xsd:IDREFS.
static final short	INT_TYPE	xsd:int.
static final short	INTEGER_TYPE	xsd:integer.
static final short	LANGUAGE_TYPE	xsd:language.
static final short	LONG_TYPE	xsd:long.
static final short	NAME_TYPE	xsd:name.
static final short	NCNAME_TYPE	xsd:NCNAME.
static final short	NEGATIVE_INTEGER_TYPE	xsd:negativeInteger.
static final short	NMTOKEN_TYPE	xsd:NMTOKEN.
static final short	NMTOKENS_TYPE	xsd:NMTOKENS.
static final short	NON_NEGATIVE_INTEGER_TYPE	xsd:nonNegativeInteger.
static final short	NON_POSITIVE_INTEGER_TYPE	xsd:nonPositiveInteger.
static final short	NORMALIZEDSTRING_TYPE	xsd:normalizedString.
static final short	NOTATION_TYPE	xsd:notation.
static final short	NULL	Value meaning the type is unassigned.
static final short	POSITIVE_INTEGER_TYPE	xsd:positiveInteger.
static final short	QNAME_TYPE	xsd:QName.
static final short	SHORT_TYPE	xsd:short.
static final short	STRING_TYPE	xsd:string.
static final short	TIME_TYPE	xsd:time.
static final short	TOKEN_TYPE	xsd:token.
static final short	UNSIGNED_BYTE_TYPE	xsd:unsignedByte.
static final short	UNSIGNED_INT_TYPE	xsd:unsignedInt.
static final short	UNSIGNED_LONG_TYPE	xsd:unsignedLong.
static final short	UNSIGNED_SHORT_TYPE	xsd:unsignedShort.

Constructor Summary

Constructors

Constructor	Description
AbstractPatternFacet()

Method Summary

Modifier and Type	Method	Description
final void	addPattern(String pattern)	Adds a pattern branch for this XSType.
protected final void	addPatternFacet(Facet facet)	Transfer given facet if it is a pattern.
protected final void	codePatternFacet(JSourceCode jsc, String validatorName)	Generate the source code for pattern facet validation.
final List<String>	getPatterns()	Get list of pattern facets.
protected void	setFacet(Facet facet)	Set the given facet for XSType if applicable.

Methods inherited from class XSType

createDefaultValueWithString, createFromJavaObjectCode, createToJavaObjectCode, getJType, getName, getType, isCollection, isDateTime, isEnumerated, isPrimitive, newInstanceCode, setAsEnumerated, setFacets, validationCode

Modifier and Type	Method	Description
String	createDefaultValueWithString(String variableName)	Creates source code for an additional constructor that deals with default values as specified in the XML schema instance.
abstract String	createFromJavaObjectCode(String variableName)	Returns the string necessary to convert an Object to an instance of this XSType.
abstract String	createToJavaObjectCode(String variableName)	Returns the string necessary to convert an instance of this XSType to an Object.
abstract JType	getJType()	Returns the JType that this XSType represents.
abstract String	getName()	Returns the name of this XSType.
abstract short	getType()	Returns the type of this XSType.
boolean	isCollection()	Returns true if this XSType represents a collection.
abstract boolean	isDateTime()	Returns true if the XSType represents an XML Schema date/time type.
final boolean	isEnumerated()	Returns true if this XSType represents an enumerated type.
abstract boolean	isPrimitive()	Returns true if this XSType represents a primitive type.
abstract String	newInstanceCode()	Returns the Java code neccessary to create a new instance of the JType associated with this XSType.
final void	setAsEnumerated(boolean enumerated)	Sets the enumerated flag for this XSClass.
final void	setFacets(SimpleType simpleType)	Reads and sets the facets for XSType.
abstract void	validationCode(JSourceCode jsc, String fixedValue, String validatorInstanceName)	Creates the validation code for an instance of this XSType.

Methods inherited from class Object

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

Constructor Details

AbstractPatternFacet

public AbstractPatternFacet()

Method Details

addPattern

public final void addPattern(String pattern)

Adds a pattern branch for this XSType. To successfully pass the pattern facets, only one branch needs to pass.

Parameters:

pattern - The regular expression for this XSType.

getPatterns

public final List<String> getPatterns()

Get list of pattern facets.

Returns:

List of pattern facets.

setFacet

protected void setFacet(Facet facet)

Set the given facet for XSType if applicable.

Specified by:

setFacet in class XSType

Parameters:

facet - The facet to set for XSType.

addPatternFacet

protected final void addPatternFacet(Facet facet)

Transfer given facet if it is a pattern.

Parameters:

facet - The facet to transfer.

codePatternFacet

protected final void codePatternFacet(JSourceCode jsc,
 String validatorName)

Generate the source code for pattern facet validation.

Parameters:

jsc - The JSourceCode to fill in.

validatorName - The name of the TypeValidator that the patterns should be added to.