<!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:48:43 GMT 2011 -->
<TITLE>
Cardinality
</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="Cardinality";
}
}
</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="../../../../net/sf/saxon/value/CalendarValue.html" title="class in net.sf.saxon.value"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/value/Closure.html" title="class in net.sf.saxon.value"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/value/Cardinality.html" target="_top"><B>FRAMES</B></A>
<A HREF="Cardinality.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <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">
net.sf.saxon.value</FONT>
<BR>
Class Cardinality</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>net.sf.saxon.value.Cardinality</B>
</PRE>
<HR>
<DL>
<DT><PRE>public final class <B>Cardinality</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></DL>
</PRE>
<P>
This class contains static methods to manipulate the cardinality
property of a type.
Cardinality of expressions is denoted by one of the values ONE_OR_MORE, ZERO_OR_MORE,
ZERO_OR_ONE, EXACTLY_ONE, or EMPTY. These are combinations of the three bit-significant
values ALLOWS_ZERO, ALLOWS_ONE, and ALLOWS_MANY.
<P>
<P>
<HR>
<P>
<!-- ========== 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>static boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/Cardinality.html#allowsMany(int)">allowsMany</A></B>(int cardinality)</CODE>
<BR>
Determine whether multiple occurrences are allowed</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="../../../../net/sf/saxon/value/Cardinality.html#allowsZero(int)">allowsZero</A></B>(int cardinality)</CODE>
<BR>
Determine whether empty sequence is allowed</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="../../../../net/sf/saxon/value/Cardinality.html#expectsMany(net.sf.saxon.expr.Expression)">expectsMany</A></B>(<A HREF="../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> expression)</CODE>
<BR>
Determine whether multiple occurrences are not only allowed, but likely.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <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="../../../../net/sf/saxon/value/Cardinality.html#getOccurrenceIndicator(int)">getOccurrenceIndicator</A></B>(int cardinality)</CODE>
<BR>
Get the occurence indicator representing the cardinality</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/Cardinality.html#multiply(int, int)">multiply</A></B>(int c1,
int c2)</CODE>
<BR>
Multiply two cardinalities</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="../../../../net/sf/saxon/value/Cardinality.html#subsumes(int, int)">subsumes</A></B>(int c1,
int c2)</CODE>
<BR>
Test if one cardinality subsumes another.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/Cardinality.html#sum(int, int)">sum</A></B>(int c1,
int c2)</CODE>
<BR>
Add two cardinalities</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <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="../../../../net/sf/saxon/value/Cardinality.html#toString(int)">toString</A></B>(int cardinality)</CODE>
<BR>
Display the cardinality as a string</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/Cardinality.html#union(int, int)">union</A></B>(int c1,
int c2)</CODE>
<BR>
Form the union of two cardinalities.</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>
<!-- ============ 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="allowsMany(int)"><!-- --></A><H3>
allowsMany</H3>
<PRE>
public static boolean <B>allowsMany</B>(int cardinality)</PRE>
<DL>
<DD>Determine whether multiple occurrences are allowed
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cardinality</CODE> - the cardinality of a sequence
<DT><B>Returns:</B><DD>true if the cardinality allows the sequence to contain more than one item</DL>
</DD>
</DL>
<HR>
<A NAME="expectsMany(net.sf.saxon.expr.Expression)"><!-- --></A><H3>
expectsMany</H3>
<PRE>
public static boolean <B>expectsMany</B>(<A HREF="../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> expression)</PRE>
<DL>
<DD>Determine whether multiple occurrences are not only allowed, but likely.
This returns false for an expression that is the atomization of a singleton
node, since in that case it's quite unusual for the typed value to be a
non-singleton sequence.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>expression</CODE> - an expression
<DT><B>Returns:</B><DD>true if multiple occurrences are not only allowed, but likely. Return
false if multiple occurrences are unlikely, even though they might be allowed.
This is typically the case for the atomized sequence that is obtained by atomizing
a singleton node.</DL>
</DD>
</DL>
<HR>
<A NAME="allowsZero(int)"><!-- --></A><H3>
allowsZero</H3>
<PRE>
public static boolean <B>allowsZero</B>(int cardinality)</PRE>
<DL>
<DD>Determine whether empty sequence is allowed
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cardinality</CODE> - the cardinality of a sequence
<DT><B>Returns:</B><DD>true if the cardinality allows the sequence to be empty</DL>
</DD>
</DL>
<HR>
<A NAME="union(int, int)"><!-- --></A><H3>
union</H3>
<PRE>
public static int <B>union</B>(int c1,
int c2)</PRE>
<DL>
<DD>Form the union of two cardinalities. The cardinality of the expression "if (c) then e1 else e2"
is the union of the cardinalities of e1 and e2.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>c1</CODE> - a cardinality<DD><CODE>c2</CODE> - another cardinality
<DT><B>Returns:</B><DD>the cardinality that allows both c1 and c2</DL>
</DD>
</DL>
<HR>
<A NAME="sum(int, int)"><!-- --></A><H3>
sum</H3>
<PRE>
public static int <B>sum</B>(int c1,
int c2)</PRE>
<DL>
<DD>Add two cardinalities
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>c1</CODE> - the first cardinality<DD><CODE>c2</CODE> - the second cardinality
<DT><B>Returns:</B><DD>the cardinality of a sequence formed by concatenating the sequences whose cardinalities
are c1 and c2</DL>
</DD>
</DL>
<HR>
<A NAME="subsumes(int, int)"><!-- --></A><H3>
subsumes</H3>
<PRE>
public static boolean <B>subsumes</B>(int c1,
int c2)</PRE>
<DL>
<DD>Test if one cardinality subsumes another. Cardinality c1 subsumes c2 if every option permitted
by c2 is also permitted by c1.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>c1</CODE> - a cardinality<DD><CODE>c2</CODE> - another cardinality
<DT><B>Returns:</B><DD>true if if every option permitted
by c2 is also permitted by c1.</DL>
</DD>
</DL>
<HR>
<A NAME="multiply(int, int)"><!-- --></A><H3>
multiply</H3>
<PRE>
public static int <B>multiply</B>(int c1,
int c2)</PRE>
<DL>
<DD>Multiply two cardinalities
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>c1</CODE> - the first cardinality<DD><CODE>c2</CODE> - the second cardinality
<DT><B>Returns:</B><DD>the product of the cardinalities, that is, the cardinality of the sequence
"for $x in S1 return S2", where c1 is the cardinality of S1 and c2 is the cardinality of S2</DL>
</DD>
</DL>
<HR>
<A NAME="toString(int)"><!-- --></A><H3>
toString</H3>
<PRE>
public static <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>toString</B>(int cardinality)</PRE>
<DL>
<DD>Display the cardinality as a string
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cardinality</CODE> - the cardinality value to be displayed
<DT><B>Returns:</B><DD>the representation as a string, for example "zero or one", "zero or more"</DL>
</DD>
</DL>
<HR>
<A NAME="getOccurrenceIndicator(int)"><!-- --></A><H3>
getOccurrenceIndicator</H3>
<PRE>
public static <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>getOccurrenceIndicator</B>(int cardinality)</PRE>
<DL>
<DD>Get the occurence indicator representing the cardinality
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cardinality</CODE> - the cardinality value
<DT><B>Returns:</B><DD>the occurrence indicator, for example "*", "+", "?", "".</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="../../../../net/sf/saxon/value/CalendarValue.html" title="class in net.sf.saxon.value"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/value/Closure.html" title="class in net.sf.saxon.value"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/value/Cardinality.html" target="_top"><B>FRAMES</B></A>
<A HREF="Cardinality.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <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>
