<!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:48 GMT 2011 -->
<TITLE>
AutomatonState
</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="AutomatonState";
}
}
</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">
PREV CLASS
<A HREF="../../../../com/saxonica/schema/fsa/CountingState.html" title="class in com.saxonica.schema.fsa"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/saxonica/schema/fsa/AutomatonState.html" target="_top"><B>FRAMES</B></A>
<A HREF="AutomatonState.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <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.fsa</FONT>
<BR>
Class AutomatonState</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.fsa.AutomatonState</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/saxonica/schema/fsa/State.html" title="interface in com.saxonica.schema.fsa">State</A>, <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/fsa/DeterminizedState.html" title="class in com.saxonica.schema.fsa">DeterminizedState</A>, <A HREF="../../../../com/saxonica/schema/fsa/NonDeterminizedState.html" title="class in com.saxonica.schema.fsa">NonDeterminizedState</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class <B>AutomatonState</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="../../../../com/saxonica/schema/fsa/State.html" title="interface in com.saxonica.schema.fsa">State</A></DL>
</PRE>
<P>
Defines a state of a finite state machine used when validating an instance against
a complex type. Each State knows about the possible
transitions to other states, and knows whether it is a final state. The initial
state is referenced from the FiniteStateMachine object, which is itself a property
of the UserComplexType against which validation is being performed.
<p>This class is designed for internal use only.</p>
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.saxonica.schema.fsa.AutomatonState">Serialized Form</A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_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>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/schema/fsa/AutomatonState.html#EMPTY_EDGE_ARRAY">EMPTY_EDGE_ARRAY</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/schema/fsa/AutomatonState.html#wildcardEdges">wildcardEdges</A></B></CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ======== 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/fsa/AutomatonState.html#AutomatonState(com.saxonica.schema.fsa.FiniteStateMachine)">AutomatonState</A></B>(<A HREF="../../../../com/saxonica/schema/fsa/FiniteStateMachine.html" title="class in com.saxonica.schema.fsa">FiniteStateMachine</A> machine)</CODE>
<BR>
Create a new state</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/fsa/AutomatonState.html#addSpecificTransition(com.saxonica.schema.fsa.Edge, com.saxonica.schema.SchemaCompiler)">addSpecificTransition</A></B>(<A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A> edge,
<A HREF="../../../../com/saxonica/schema/SchemaCompiler.html" title="class in com.saxonica.schema">SchemaCompiler</A> compiler)</CODE>
<BR>
Add a specific transition from this state to another state.</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/fsa/AutomatonState.html#addWildcardTransition(com.saxonica.schema.SchemaCompiler, com.saxonica.schema.fsa.Edge)">addWildcardTransition</A></B>(<A HREF="../../../../com/saxonica/schema/SchemaCompiler.html" title="class in com.saxonica.schema">SchemaCompiler</A> compiler,
<A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A> transition)</CODE>
<BR>
Add a wildcard transition from this state to another state.</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/fsa/AutomatonState.html#display(java.util.HashMap)">display</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</A><<A HREF="../../../../com/saxonica/schema/fsa/AutomatonState.html" title="class in com.saxonica.schema.fsa">AutomatonState</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A>> map)</CODE>
<BR>
Display the finite state machine reachable from this state.</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/fsa/AutomatonState.html#displayLambdaTransitions()">displayLambdaTransitions</A></B>()</CODE>
<BR>
Display the lambda transitions available from this state</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/fsa/AutomatonState.html#displayState(java.io.PrintStream)">displayState</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</A> err)</CODE>
<BR>
Display the finite state machine reachable from this state.</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/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A>></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/schema/fsa/AutomatonState.html#getEdges()">getEdges</A></B>()</CODE>
<BR>
Get an iterator over all the transitions (edges) allowed from this state</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/schema/fsa/AutomatonState.html#getMaxTransition()">getMaxTransition</A></B>()</CODE>
<BR>
Get the transition to be used when the maxOccurs value is reached for a counting state.</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/fsa/AutomatonState.html#getStateNumber()">getStateNumber</A></B>()</CODE>
<BR>
Get the state number</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/schema/fsa/AutomatonState.html#getTransition(int, com.saxonica.schema.UserComplexType)">getTransition</A></B>(int token,
<A HREF="../../../../com/saxonica/schema/UserComplexType.html" title="class in com.saxonica.schema">UserComplexType</A> type)</CODE>
<BR>
Find the edge representing the transition from this state to another state, that is
triggered by a given input token</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/schema/fsa/AutomatonState.html#getWildcardEdges()">getWildcardEdges</A></B>()</CODE>
<BR>
Get an iterator over the wildcard transitions (edges) allowed from this state.</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/fsa/AutomatonState.html#isConditionallyFinalState()">isConditionallyFinalState</A></B>()</CODE>
<BR>
Test whether this state is a final state assuming the counter has reached its minimum value</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/fsa/AutomatonState.html#isFinalState()">isFinalState</A></B>()</CODE>
<BR>
Test whether this state is a final state</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/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/schema/fsa/AutomatonState.html#listAllowedElements()">listAllowedElements</A></B>()</CODE>
<BR>
List the allowed elements in this state as a string, for use in error messages</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/fsa/AutomatonState.html#requiresCounter()">requiresCounter</A></B>()</CODE>
<BR>
Ask whether this is a counting state</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/fsa/AutomatonState.html#serialize(com.saxonica.schema.SchemaModelSerializer)">serialize</A></B>(<A HREF="../../../../com/saxonica/schema/SchemaModelSerializer.html" title="class in com.saxonica.schema">SchemaModelSerializer</A> serializer)</CODE>
<BR>
Serialize this state as part of the serialization of a 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/fsa/AutomatonState.html#setFinalState(boolean)">setFinalState</A></B>(boolean finalState)</CODE>
<BR>
Set this state to be (or not to be) a final state</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/fsa/AutomatonState.html#setLimits(int, int)">setLimits</A></B>(int min,
int max)</CODE>
<BR>
Set the counter limits</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/fsa/AutomatonState.html#setMaxTransition(com.saxonica.schema.fsa.Edge)">setMaxTransition</A></B>(<A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A> edge)</CODE>
<BR>
A counting state may have a special Edge that is used when the maxOccurs value is reached.</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>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="wildcardEdges"><!-- --></A><H3>
wildcardEdges</H3>
<PRE>
protected <A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A>[] <B>wildcardEdges</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="EMPTY_EDGE_ARRAY"><!-- --></A><H3>
EMPTY_EDGE_ARRAY</H3>
<PRE>
public static final <A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A>[] <B>EMPTY_EDGE_ARRAY</B></PRE>
<DL>
<DL>
</DL>
</DL>
<!-- ========= 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="AutomatonState(com.saxonica.schema.fsa.FiniteStateMachine)"><!-- --></A><H3>
AutomatonState</H3>
<PRE>
public <B>AutomatonState</B>(<A HREF="../../../../com/saxonica/schema/fsa/FiniteStateMachine.html" title="class in com.saxonica.schema.fsa">FiniteStateMachine</A> machine)</PRE>
<DL>
<DD>Create a new state
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>machine</CODE> - the finite state machine to which this State belongs</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="isFinalState()"><!-- --></A><H3>
isFinalState</H3>
<PRE>
public boolean <B>isFinalState</B>()</PRE>
<DL>
<DD>Test whether this state is a final state
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/saxonica/schema/fsa/State.html#isFinalState()">isFinalState</A></CODE> in interface <CODE><A HREF="../../../../com/saxonica/schema/fsa/State.html" title="interface in com.saxonica.schema.fsa">State</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if this is a final state</DL>
</DD>
</DL>
<HR>
<A NAME="isConditionallyFinalState()"><!-- --></A><H3>
isConditionallyFinalState</H3>
<PRE>
public boolean <B>isConditionallyFinalState</B>()</PRE>
<DL>
<DD>Test whether this state is a final state assuming the counter has reached its minimum value
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if this state is a final state when the minimum number of occurrences is reached</DL>
</DD>
</DL>
<HR>
<A NAME="setFinalState(boolean)"><!-- --></A><H3>
setFinalState</H3>
<PRE>
public void <B>setFinalState</B>(boolean finalState)</PRE>
<DL>
<DD>Set this state to be (or not to be) a final state
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>finalState</CODE> - true if this state is final</DL>
</DD>
</DL>
<HR>
<A NAME="getStateNumber()"><!-- --></A><H3>
getStateNumber</H3>
<PRE>
public int <B>getStateNumber</B>()</PRE>
<DL>
<DD>Get the state number
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the state number</DL>
</DD>
</DL>
<HR>
<A NAME="addSpecificTransition(com.saxonica.schema.fsa.Edge, com.saxonica.schema.SchemaCompiler)"><!-- --></A><H3>
addSpecificTransition</H3>
<PRE>
public void <B>addSpecificTransition</B>(<A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A> edge,
<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>Add a specific transition from this state to another state. This
transition accepts a specific element name only.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>edge</CODE> - the transition to be added<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 there are two transitions for the same element
declaration, that is, if the content model is ambiguous</DL>
</DD>
</DL>
<HR>
<A NAME="addWildcardTransition(com.saxonica.schema.SchemaCompiler, com.saxonica.schema.fsa.Edge)"><!-- --></A><H3>
addWildcardTransition</H3>
<PRE>
public void <B>addWildcardTransition</B>(<A HREF="../../../../com/saxonica/schema/SchemaCompiler.html" title="class in com.saxonica.schema">SchemaCompiler</A> compiler,
<A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A> transition)
throws <A HREF="../../../../net/sf/saxon/type/SchemaException.html" title="class in net.sf.saxon.type">SchemaException</A></PRE>
<DL>
<DD>Add a wildcard transition from this state to another state.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>compiler</CODE> - the schema compiler<DD><CODE>transition</CODE> - the edge representing the transition
<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 transition cannot be added because
it would generate an inconsistency</DL>
</DD>
</DL>
<HR>
<A NAME="setLimits(int, int)"><!-- --></A><H3>
setLimits</H3>
<PRE>
public void <B>setLimits</B>(int min,
int max)</PRE>
<DL>
<DD>Set the counter limits
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>min</CODE> - the minimum number of occurrences of counting edges before a non-counting edge is used<DD><CODE>max</CODE> - the maximum number of occurrences of counting edges before a non-counting edge is used;
the value -1 means unbounded</DL>
</DD>
</DL>
<HR>
<A NAME="requiresCounter()"><!-- --></A><H3>
requiresCounter</H3>
<PRE>
public boolean <B>requiresCounter</B>()</PRE>
<DL>
<DD>Ask whether this is a counting state
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if this state requires a counter to be maintained</DL>
</DD>
</DL>
<HR>
<A NAME="getTransition(int, com.saxonica.schema.UserComplexType)"><!-- --></A><H3>
getTransition</H3>
<PRE>
public <A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A> <B>getTransition</B>(int token,
<A HREF="../../../../com/saxonica/schema/UserComplexType.html" title="class in com.saxonica.schema">UserComplexType</A> type)</PRE>
<DL>
<DD>Find the edge representing the transition from this state to another state, that is
triggered by a given input token
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/saxonica/schema/fsa/State.html#getTransition(int, com.saxonica.schema.UserComplexType)">getTransition</A></CODE> in interface <CODE><A HREF="../../../../com/saxonica/schema/fsa/State.html" title="interface in com.saxonica.schema.fsa">State</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>token</CODE> - the input token, specifically the fingerprint of an element name<DD><CODE>type</CODE> - the complex type we are validating against
<DT><B>Returns:</B><DD>the Edge representing the selected transition of the finite state machine,
or null if this token is not accepted when in this State (which implies a validation error).</DL>
</DD>
</DL>
<HR>
<A NAME="listAllowedElements()"><!-- --></A><H3>
listAllowedElements</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> <B>listAllowedElements</B>()</PRE>
<DL>
<DD>List the allowed elements in this state as a string, for use in error messages
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/saxonica/schema/fsa/State.html#listAllowedElements()">listAllowedElements</A></CODE> in interface <CODE><A HREF="../../../../com/saxonica/schema/fsa/State.html" title="interface in com.saxonica.schema.fsa">State</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the list of permitted elements as a string containing comma-separated element names</DL>
</DD>
</DL>
<HR>
<A NAME="getWildcardEdges()"><!-- --></A><H3>
getWildcardEdges</H3>
<PRE>
public <A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A>[] <B>getWildcardEdges</B>()</PRE>
<DL>
<DD>Get an iterator over the wildcard transitions (edges) allowed from this state.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/saxonica/schema/fsa/State.html#getWildcardEdges()">getWildcardEdges</A></CODE> in interface <CODE><A HREF="../../../../com/saxonica/schema/fsa/State.html" title="interface in com.saxonica.schema.fsa">State</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>an Iterator over the edges that represent element wildcards. The objects
returned by this Iterator are <A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa"><CODE>Edge</CODE></A> objects.</DL>
</DD>
</DL>
<HR>
<A NAME="getEdges()"><!-- --></A><H3>
getEdges</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A>> <B>getEdges</B>()</PRE>
<DL>
<DD>Get an iterator over all the transitions (edges) allowed from this state
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/saxonica/schema/fsa/State.html#getEdges()">getEdges</A></CODE> in interface <CODE><A HREF="../../../../com/saxonica/schema/fsa/State.html" title="interface in com.saxonica.schema.fsa">State</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>an Iterator over all the edges from this state. The objects
returned by this Iterator are <A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa"><CODE>Edge</CODE></A> objects.</DL>
</DD>
</DL>
<HR>
<A NAME="display(java.util.HashMap)"><!-- --></A><H3>
display</H3>
<PRE>
public void <B>display</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</A><<A HREF="../../../../com/saxonica/schema/fsa/AutomatonState.html" title="class in com.saxonica.schema.fsa">AutomatonState</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A>> map)</PRE>
<DL>
<DD>Display the finite state machine reachable from this state. This is a diagnostic method for
internal use. Output is written to System.err. At present, wildcard transitions are not shown.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>map</CODE> - a Hashmap mapping states already processed to the integer values used to represent that state.
The method should be called initially with an empty map.</DL>
</DD>
</DL>
<HR>
<A NAME="displayState(java.io.PrintStream)"><!-- --></A><H3>
displayState</H3>
<PRE>
public void <B>displayState</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</A> err)</PRE>
<DL>
<DD>Display the finite state machine reachable from this state. This is a diagnostic method for
internal use. Output is written to System.err. At present, wildcard transitions are not shown.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>err</CODE> - the output destination destination</DL>
</DD>
</DL>
<HR>
<A NAME="displayLambdaTransitions()"><!-- --></A><H3>
displayLambdaTransitions</H3>
<PRE>
public void <B>displayLambdaTransitions</B>()</PRE>
<DL>
<DD>Display the lambda transitions available from this state
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setMaxTransition(com.saxonica.schema.fsa.Edge)"><!-- --></A><H3>
setMaxTransition</H3>
<PRE>
public void <B>setMaxTransition</B>(<A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A> edge)</PRE>
<DL>
<DD>A counting state may have a special Edge that is used when the maxOccurs value is reached.
This method sets this edge.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>edge</CODE> - the transition to be used when the maxOccurs value is reached</DL>
</DD>
</DL>
<HR>
<A NAME="getMaxTransition()"><!-- --></A><H3>
getMaxTransition</H3>
<PRE>
public <A HREF="../../../../com/saxonica/schema/fsa/Edge.html" title="class in com.saxonica.schema.fsa">Edge</A> <B>getMaxTransition</B>()</PRE>
<DL>
<DD>Get the transition to be used when the maxOccurs value is reached for a counting state.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the max transition if there is one, else null.</DL>
</DD>
</DL>
<HR>
<A NAME="serialize(com.saxonica.schema.SchemaModelSerializer)"><!-- --></A><H3>
serialize</H3>
<PRE>
public void <B>serialize</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 state as part of the serialization of a schema component model
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>serializer</CODE> - used to output the model
<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 any failure occurs</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">
PREV CLASS
<A HREF="../../../../com/saxonica/schema/fsa/CountingState.html" title="class in com.saxonica.schema.fsa"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/saxonica/schema/fsa/AutomatonState.html" target="_top"><B>FRAMES</B></A>
<A HREF="AutomatonState.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <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>
