com.saxonica.schema
Class PatternFacet

java.lang.Object
  extended by com.saxonica.schema.Facet
      extended by com.saxonica.schema.PatternFacet
All Implemented Interfaces:
Serializable

public class PatternFacet
extends Facet

Represents a pattern facet on a schema-defined simple type

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.saxonica.schema.Facet
ENUMERATION, FRACTIONDIGITS, LENGTH, MAX_EXCLUSIVE, MAX_INCLUSIVE, MAX_LENGTH, MIN_EXCLUSIVE, MIN_INCLUSIVE, MIN_LENGTH, PATTERN, TOTALDIGITS, WHITESPACE
 
Constructor Summary
PatternFacet(Configuration config)
          Create a pattern facet
 
Method Summary
 void addBranch(String pat)
          Add a branch to a pattern: that is, combine this pattern with another, so that the resulting pattern is the "or" of the two patterns
 boolean appliesToWholeList()
          Test whether this is a facet that can be used to test the normalized value of a list type.
 void checkFacetRestriction(UserSimpleType type, SimpleType base)
          Check that this facet is legal when used on a type derived by restriction
 String getName()
          Returns the name of this Facet
 String getValue()
          Returns the character (String) representation of this facet
 void setValue(String value)
          Set the string value of the facet
 boolean testAtomicValue(AtomicValue value)
          Test whether an atomic value conforms to this facet
 
Methods inherited from class com.saxonica.schema.Facet
getWhitespaceAction, isFacetName, isFixed, isNewlyIntroduced, makeFacet, serializeFacet, setFixed, testLength, toLong
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PatternFacet

public PatternFacet(Configuration config)
Create a pattern facet

Parameters:
config - the Saxon configuration
Method Detail

getName

public String getName()
Description copied from class: Facet
Returns the name of this Facet

Overrides:
getName in class Facet
Returns:
the name of this Facet

getValue

public String getValue()
Description copied from class: Facet
Returns the character (String) representation of this facet

Overrides:
getValue in class Facet
Returns:
the value of this facet

setValue

public void setValue(String value)
              throws SchemaException
Description copied from class: Facet
Set the string value of the facet

Overrides:
setValue in class Facet
Parameters:
value - the string value of the facet
Throws:
SchemaException

addBranch

public void addBranch(String pat)
Add a branch to a pattern: that is, combine this pattern with another, so that the resulting pattern is the "or" of the two patterns

Parameters:
pat - the new branch, which must be a valid regular expression

checkFacetRestriction

public void checkFacetRestriction(UserSimpleType type,
                                  SimpleType base)
                           throws SchemaException
Check that this facet is legal when used on a type derived by restriction

Overrides:
checkFacetRestriction in class Facet
Parameters:
base - the type from which the restricted type is derived
type - the type on which the facet is defined
Throws:
SchemaException - if the facet is not legal

appliesToWholeList

public boolean appliesToWholeList()
Test whether this is a facet that can be used to test the normalized value of a list type. (Specifically, this is true only for pattern facets and enumeration facets)

Overrides:
appliesToWholeList in class Facet
Returns:
true if this is a facet that applies to the whole list

testAtomicValue

public boolean testAtomicValue(AtomicValue value)
Test whether an atomic value conforms to this facet

Overrides:
testAtomicValue in class Facet
Parameters:
value - the value to be tested
Returns:
true if the value conforms; false if it doesn't conform, or if the test fails


Copyright (C) Michael H. Kay. All rights reserved.