<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:47:47 GMT 2011 -->
<TITLE>
Facet
</TITLE>
<META NAME="date" CONTENT="2011-12-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Facet";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/saxonica/schema/ExplicitTimezoneFacet.html" title="class in com.saxonica.schema"><B>PREV CLASS</B></A>
<A HREF="../../../com/saxonica/schema/FractionDigitsFacet.html" title="class in com.saxonica.schema"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/saxonica/schema/Facet.html" target="_top"><B>FRAMES</B></A>
<A HREF="Facet.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.saxonica.schema</FONT>
<BR>
Class Facet</H2>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.saxonica.schema.Facet</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../com/saxonica/schema/AssertionFacet.html" title="class in com.saxonica.schema">AssertionFacet</A>, <A HREF="../../../com/saxonica/schema/DigitsFacet.html" title="class in com.saxonica.schema">DigitsFacet</A>, <A HREF="../../../com/saxonica/schema/EnumerationFacet.html" title="class in com.saxonica.schema">EnumerationFacet</A>, <A HREF="../../../com/saxonica/schema/EnumerationFacetSet.html" title="class in com.saxonica.schema">EnumerationFacetSet</A>, <A HREF="../../../com/saxonica/schema/ExplicitTimezoneFacet.html" title="class in com.saxonica.schema">ExplicitTimezoneFacet</A>, <A HREF="../../../com/saxonica/schema/LengthRangeFacet.html" title="class in com.saxonica.schema">LengthRangeFacet</A>, <A HREF="../../../com/saxonica/schema/PatternFacet.html" title="class in com.saxonica.schema">PatternFacet</A>, <A HREF="../../../com/saxonica/schema/PreprocessFacet.html" title="class in com.saxonica.schema">PreprocessFacet</A>, <A HREF="../../../com/saxonica/schema/ValueRangeFacet.html" title="class in com.saxonica.schema">ValueRangeFacet</A>, <A HREF="../../../com/saxonica/schema/WhitespaceFacet.html" title="class in com.saxonica.schema">WhitespaceFacet</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class <B>Facet</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL>
</PRE>
<P>
Represents an XML Schema Facet. Most facets are represented by subclasses of this
class, the only exception is whiteSpace.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#com.saxonica.schema.Facet">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#Facet()">Facet</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#checkFacetRestriction(com.saxonica.schema.UserSimpleType, net.sf.saxon.type.SimpleType, com.saxonica.schema.SchemaCompiler)">checkFacetRestriction</A></B>(<A HREF="../../../com/saxonica/schema/UserSimpleType.html" title="class in com.saxonica.schema">UserSimpleType</A> type,
<A HREF="../../../net/sf/saxon/type/SimpleType.html" title="interface in net.sf.saxon.type">SimpleType</A> base,
<A HREF="../../../com/saxonica/schema/SchemaCompiler.html" title="class in com.saxonica.schema">SchemaCompiler</A> compiler)</CODE>
<BR>
Check that this facet is legal when used on a type derived by restriction</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#getMessage()">getMessage</A></B>()</CODE>
<BR>
Get the message to be used when this facet is violated.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#getName()">getName</A></B>()</CODE>
<BR>
Returns the name of this Facet</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#getValue()">getValue</A></B>()</CODE>
<BR>
Returns the lexical representation of the value of this facet</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#getWhitespaceAction()">getWhitespaceAction</A></B>()</CODE>
<BR>
Get the whitespace action required by this facet: one of PRESERVE, REPLACE, or COLLAPSE.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#isConstraining()">isConstraining</A></B>()</CODE>
<BR>
Ask whether this is a constraining facet (as distinct from a pre-lexical facet)</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#isFacetName(java.lang.String, int)">isFacetName</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
int xsdVersion)</CODE>
<BR>
Test whether a given string is one of the recognized facet names</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#isFixed()">isFixed</A></B>()</CODE>
<BR>
Ask whether the facet is defined in the schema with fixed="true"</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#isNewlyIntroduced(net.sf.saxon.type.SimpleType)">isNewlyIntroduced</A></B>(<A HREF="../../../net/sf/saxon/type/SimpleType.html" title="interface in net.sf.saxon.type">SimpleType</A> base)</CODE>
<BR>
Test whether this facet is newly introduced on this type, that is, whether it is absent
from the base type</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../com/saxonica/schema/Facet.html" title="class in com.saxonica.schema">Facet</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#makeFacet(java.lang.String, java.lang.String, com.saxonica.config.EnterpriseConfiguration, net.sf.saxon.om.NamespaceResolver, com.saxonica.schema.SchemaCompiler)">makeFacet</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value,
<A HREF="../../../com/saxonica/config/EnterpriseConfiguration.html" title="class in com.saxonica.config">EnterpriseConfiguration</A> config,
<A HREF="../../../net/sf/saxon/om/NamespaceResolver.html" title="interface in net.sf.saxon.om">NamespaceResolver</A> resolver,
<A HREF="../../../com/saxonica/schema/SchemaCompiler.html" title="class in com.saxonica.schema">SchemaCompiler</A> compiler)</CODE>
<BR>
Factory method: creates a new Facet with the given name</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#serializeFacet(com.saxonica.schema.SchemaModelSerializer)">serializeFacet</A></B>(<A HREF="../../../com/saxonica/schema/SchemaModelSerializer.html" title="class in com.saxonica.schema">SchemaModelSerializer</A> serializer)</CODE>
<BR>
Serialize this facet when externalizing the schema component model</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#setFixed(boolean)">setFixed</A></B>(boolean fixed)</CODE>
<BR>
Say whether the facet is defined as fixed</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#setMessage(java.lang.String)">setMessage</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> message)</CODE>
<BR>
Set the message to be used when this facet is violated.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#testAtomicValue(net.sf.saxon.value.AtomicValue)">testAtomicValue</A></B>(<A HREF="../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A> value)</CODE>
<BR>
Test whether an atomic value conforms to this facet</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#testLength(int)">testLength</A></B>(int count)</CODE>
<BR>
Test whether the length of a list conforms to this facet.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#testListValue(net.sf.saxon.value.Value)">testListValue</A></B>(<A HREF="../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A> value)</CODE>
<BR>
Test whether a list value conforms to this facet.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/saxonica/schema/Facet.html#toLong()">toLong</A></B>()</CODE>
<BR>
Returns the numeric value of this facet, for facets where this is appropriate</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="Facet()"><!-- --></A><H3>
Facet</H3>
<PRE>
public <B>Facet</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="setFixed(boolean)"><!-- --></A><H3>
setFixed</H3>
<PRE>
public void <B>setFixed</B>(boolean fixed)</PRE>
<DL>
<DD>Say whether the facet is defined as fixed
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fixed</CODE> - true if the facet is fixed</DL>
</DD>
</DL>
<HR>
<A NAME="isFixed()"><!-- --></A><H3>
isFixed</H3>
<PRE>
public boolean <B>isFixed</B>()</PRE>
<DL>
<DD>Ask whether the facet is defined in the schema with fixed="true"
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if fixed</DL>
</DD>
</DL>
<HR>
<A NAME="isConstraining()"><!-- --></A><H3>
isConstraining</H3>
<PRE>
public boolean <B>isConstraining</B>()</PRE>
<DL>
<DD>Ask whether this is a constraining facet (as distinct from a pre-lexical facet)
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if this is a constraining facet</DL>
</DD>
</DL>
<HR>
<A NAME="setMessage(java.lang.String)"><!-- --></A><H3>
setMessage</H3>
<PRE>
public void <B>setMessage</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> message)</PRE>
<DL>
<DD>Set the message to be used when this facet is violated. If no message is supplied, a generic
message is constructed, for example "the value does not match the pattern XYZ".
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message to be used</DL>
</DD>
</DL>
<HR>
<A NAME="getMessage()"><!-- --></A><H3>
getMessage</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getMessage</B>()</PRE>
<DL>
<DD>Get the message to be used when this facet is violated.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the message, if one has been set, or null otherwise</DL>
</DD>
</DL>
<HR>
<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
public abstract <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE>
<DL>
<DD>Returns the name of this Facet
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the name of this Facet</DL>
</DD>
</DL>
<HR>
<A NAME="getValue()"><!-- --></A><H3>
getValue</H3>
<PRE>
public abstract <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getValue</B>()</PRE>
<DL>
<DD>Returns the lexical representation of the value of this facet
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the value of this facet, as a string</DL>
</DD>
</DL>
<HR>
<A NAME="toLong()"><!-- --></A><H3>
toLong</H3>
<PRE>
public long <B>toLong</B>()
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/NumberFormatException.html?is-external=true" title="class or interface in java.lang">NumberFormatException</A></PRE>
<DL>
<DD>Returns the numeric value of this facet, for facets where this is appropriate
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a long representation of the value of this facet
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/NumberFormatException.html?is-external=true" title="class or interface in java.lang">NumberFormatException</A></CODE> - if the value is not numeric</DL>
</DD>
</DL>
<HR>
<A NAME="checkFacetRestriction(com.saxonica.schema.UserSimpleType, net.sf.saxon.type.SimpleType, com.saxonica.schema.SchemaCompiler)"><!-- --></A><H3>
checkFacetRestriction</H3>
<PRE>
public void <B>checkFacetRestriction</B>(<A HREF="../../../com/saxonica/schema/UserSimpleType.html" title="class in com.saxonica.schema">UserSimpleType</A> type,
<A HREF="../../../net/sf/saxon/type/SimpleType.html" title="interface in net.sf.saxon.type">SimpleType</A> base,
<A HREF="../../../com/saxonica/schema/SchemaCompiler.html" title="class in com.saxonica.schema">SchemaCompiler</A> compiler)
throws <A HREF="../../../net/sf/saxon/type/SchemaException.html" title="class in net.sf.saxon.type">SchemaException</A>,
<A HREF="../../../net/sf/saxon/type/ValidationException.html" title="class in net.sf.saxon.type">ValidationException</A></PRE>
<DL>
<DD>Check that this facet is legal when used on a type derived by restriction
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - the type on which the facet is defined<DD><CODE>base</CODE> - the type from which the restricted type is derived<DD><CODE>compiler</CODE> - the schema compiler
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../net/sf/saxon/type/SchemaException.html" title="class in net.sf.saxon.type">SchemaException</A></CODE> - if the facet is not legal
<DD><CODE><A HREF="../../../net/sf/saxon/type/ValidationException.html" title="class in net.sf.saxon.type">ValidationException</A></CODE> - if a value is found that does not conform to the facet</DL>
</DD>
</DL>
<HR>
<A NAME="isNewlyIntroduced(net.sf.saxon.type.SimpleType)"><!-- --></A><H3>
isNewlyIntroduced</H3>
<PRE>
public boolean <B>isNewlyIntroduced</B>(<A HREF="../../../net/sf/saxon/type/SimpleType.html" title="interface in net.sf.saxon.type">SimpleType</A> base)</PRE>
<DL>
<DD>Test whether this facet is newly introduced on this type, that is, whether it is absent
from the base type
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>base</CODE> - the base type
<DT><B>Returns:</B><DD>true if the facet is present on this type and not on the base type</DL>
</DD>
</DL>
<HR>
<A NAME="testAtomicValue(net.sf.saxon.value.AtomicValue)"><!-- --></A><H3>
testAtomicValue</H3>
<PRE>
public abstract boolean <B>testAtomicValue</B>(<A HREF="../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A> value)</PRE>
<DL>
<DD>Test whether an atomic value conforms to this facet
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to be tested
<DT><B>Returns:</B><DD>true if the value conforms; false if it doesn't conform, or if the test fails</DL>
</DD>
</DL>
<HR>
<A NAME="testListValue(net.sf.saxon.value.Value)"><!-- --></A><H3>
testListValue</H3>
<PRE>
public boolean <B>testListValue</B>(<A HREF="../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A> value)</PRE>
<DL>
<DD>Test whether a list value conforms to this facet. This is used only for the enumeration
and assertion facets.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to be tested
<DT><B>Returns:</B><DD>true if the value conforms; false if it doesn't conform, or if the test fails</DL>
</DD>
</DL>
<HR>
<A NAME="testLength(int)"><!-- --></A><H3>
testLength</H3>
<PRE>
public boolean <B>testLength</B>(int count)</PRE>
<DL>
<DD>Test whether the length of a list conforms to this facet.
Always true except for length facets
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>count</CODE> - the actual length of the list
<DT><B>Returns:</B><DD>true if the facet allows a list of this length, otherwise false</DL>
</DD>
</DL>
<HR>
<A NAME="getWhitespaceAction()"><!-- --></A><H3>
getWhitespaceAction</H3>
<PRE>
public int <B>getWhitespaceAction</B>()</PRE>
<DL>
<DD>Get the whitespace action required by this facet: one of PRESERVE, REPLACE, or COLLAPSE.
Returns a dummy value of PRESERVE for facets other than whitespace facets.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the whitespace action, by default PRESERVE</DL>
</DD>
</DL>
<HR>
<A NAME="serializeFacet(com.saxonica.schema.SchemaModelSerializer)"><!-- --></A><H3>
serializeFacet</H3>
<PRE>
public void <B>serializeFacet</B>(<A HREF="../../../com/saxonica/schema/SchemaModelSerializer.html" title="class in com.saxonica.schema">SchemaModelSerializer</A> serializer)
throws <A HREF="../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Serialize this facet when externalizing the schema component model
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>serializer</CODE> - receives the content for serialization
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if an error occurs writing the value to the output</DL>
</DD>
</DL>
<HR>
<A NAME="isFacetName(java.lang.String, int)"><!-- --></A><H3>
isFacetName</H3>
<PRE>
public static boolean <B>isFacetName</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
int xsdVersion)</PRE>
<DL>
<DD>Test whether a given string is one of the recognized facet names
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - a candidate facet name, for example "totalDigits"<DD><CODE>xsdVersion</CODE> - either XSD10 or XSD11
<DT><B>Returns:</B><DD>true if the name is recognized as a facet name in the selected version of the
XSD specification</DL>
</DD>
</DL>
<HR>
<A NAME="makeFacet(java.lang.String, java.lang.String, com.saxonica.config.EnterpriseConfiguration, net.sf.saxon.om.NamespaceResolver, com.saxonica.schema.SchemaCompiler)"><!-- --></A><H3>
makeFacet</H3>
<PRE>
public static <A HREF="../../../com/saxonica/schema/Facet.html" title="class in com.saxonica.schema">Facet</A> <B>makeFacet</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value,
<A HREF="../../../com/saxonica/config/EnterpriseConfiguration.html" title="class in com.saxonica.config">EnterpriseConfiguration</A> config,
<A HREF="../../../net/sf/saxon/om/NamespaceResolver.html" title="interface in net.sf.saxon.om">NamespaceResolver</A> resolver,
<A HREF="../../../com/saxonica/schema/SchemaCompiler.html" title="class in com.saxonica.schema">SchemaCompiler</A> compiler)
throws <A HREF="../../../net/sf/saxon/type/SchemaException.html" title="class in net.sf.saxon.type">SchemaException</A></PRE>
<DL>
<DD>Factory method: creates a new Facet with the given name
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the Facet<DD><CODE>value</CODE> - the value of the Facet<DD><CODE>config</CODE> - the Saxon configuration<DD><CODE>resolver</CODE> - a namespace resolver used for resolving prefixes in namespace-sensitive enumeration values
<DT><B>Returns:</B><DD>the constructed facet
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../net/sf/saxon/type/SchemaException.html" title="class in net.sf.saxon.type">SchemaException</A></CODE> - if an error is found</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/saxonica/schema/ExplicitTimezoneFacet.html" title="class in com.saxonica.schema"><B>PREV CLASS</B></A>
<A HREF="../../../com/saxonica/schema/FractionDigitsFacet.html" title="class in com.saxonica.schema"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/saxonica/schema/Facet.html" target="_top"><B>FRAMES</B></A>
<A HREF="Facet.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
