<!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:21 GMT 2011 -->
<TITLE>
GroundedValue
</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="GroundedValue";
}
}
</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/om/FunctionItem.html" title="interface in net.sf.saxon.om"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/om/InscopeNamespaceResolver.html" title="class in net.sf.saxon.om"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/om/GroundedValue.html" target="_top"><B>FRAMES</B></A>
<A HREF="GroundedValue.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.om</FONT>
<BR>
Interface GroundedValue<T extends <A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A>></H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A><T></DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../net/sf/saxon/value/AnyURIValue.html" title="class in net.sf.saxon.value">AnyURIValue</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A>, <A HREF="../../../../net/sf/saxon/value/Base64BinaryValue.html" title="class in net.sf.saxon.value">Base64BinaryValue</A>, <A HREF="../../../../net/sf/saxon/value/BigIntegerValue.html" title="class in net.sf.saxon.value">BigIntegerValue</A>, <A HREF="../../../../net/sf/saxon/value/BooleanValue.html" title="class in net.sf.saxon.value">BooleanValue</A>, <A HREF="../../../../net/sf/saxon/value/CalendarValue.html" title="class in net.sf.saxon.value">CalendarValue</A>, <A HREF="../../../../net/sf/saxon/value/DateTimeValue.html" title="class in net.sf.saxon.value">DateTimeValue</A>, <A HREF="../../../../net/sf/saxon/value/DateValue.html" title="class in net.sf.saxon.value">DateValue</A>, <A HREF="../../../../net/sf/saxon/value/DayTimeDurationValue.html" title="class in net.sf.saxon.value">DayTimeDurationValue</A>, <A HREF="../../../../net/sf/saxon/value/DecimalValue.html" title="class in net.sf.saxon.value">DecimalValue</A>, <A HREF="../../../../net/sf/saxon/value/DoubleValue.html" title="class in net.sf.saxon.value">DoubleValue</A>, <A HREF="../../../../net/sf/saxon/value/DurationValue.html" title="class in net.sf.saxon.value">DurationValue</A>, <A HREF="../../../../net/sf/saxon/value/EmptySequence.html" title="class in net.sf.saxon.value">EmptySequence</A>, <A HREF="../../../../net/sf/saxon/value/FloatValue.html" title="class in net.sf.saxon.value">FloatValue</A>, <A HREF="../../../../net/sf/saxon/value/GDateValue.html" title="class in net.sf.saxon.value">GDateValue</A>, <A HREF="../../../../net/sf/saxon/value/GDayValue.html" title="class in net.sf.saxon.value">GDayValue</A>, <A HREF="../../../../net/sf/saxon/value/GMonthDayValue.html" title="class in net.sf.saxon.value">GMonthDayValue</A>, <A HREF="../../../../net/sf/saxon/value/GMonthValue.html" title="class in net.sf.saxon.value">GMonthValue</A>, <A HREF="../../../../net/sf/saxon/value/GYearMonthValue.html" title="class in net.sf.saxon.value">GYearMonthValue</A>, <A HREF="../../../../net/sf/saxon/value/GYearValue.html" title="class in net.sf.saxon.value">GYearValue</A>, <A HREF="../../../../net/sf/saxon/value/HexBinaryValue.html" title="class in net.sf.saxon.value">HexBinaryValue</A>, <A HREF="../../../../com/saxonica/functions/map/ImmutableMap.html" title="class in com.saxonica.functions.map">ImmutableMap</A>, <A HREF="../../../../net/sf/saxon/value/Int64Value.html" title="class in net.sf.saxon.value">Int64Value</A>, <A HREF="../../../../net/sf/saxon/value/IntegerRange.html" title="class in net.sf.saxon.value">IntegerRange</A>, <A HREF="../../../../net/sf/saxon/value/IntegerValue.html" title="class in net.sf.saxon.value">IntegerValue</A>, <A HREF="../../../../net/sf/saxon/value/NotationValue.html" title="class in net.sf.saxon.value">NotationValue</A>, <A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A>, <A HREF="../../../../net/sf/saxon/value/ObjectValue.html" title="class in net.sf.saxon.value">ObjectValue</A>, <A HREF="../../../../net/sf/saxon/value/QNameValue.html" title="class in net.sf.saxon.value">QNameValue</A>, <A HREF="../../../../net/sf/saxon/value/QualifiedNameValue.html" title="class in net.sf.saxon.value">QualifiedNameValue</A>, <A HREF="../../../../net/sf/saxon/value/SequenceExtent.html" title="class in net.sf.saxon.value">SequenceExtent</A>, <A HREF="../../../../net/sf/saxon/value/SingletonItem.html" title="class in net.sf.saxon.value">SingletonItem</A>, <A HREF="../../../../com/saxonica/functions/map/SingletonMap.html" title="class in com.saxonica.functions.map">SingletonMap</A>, <A HREF="../../../../net/sf/saxon/value/StringValue.html" title="class in net.sf.saxon.value">StringValue</A>, <A HREF="../../../../net/sf/saxon/value/TimeValue.html" title="class in net.sf.saxon.value">TimeValue</A>, <A HREF="../../../../net/sf/saxon/expr/flwor/Tuple.html" title="class in net.sf.saxon.expr.flwor">Tuple</A>, <A HREF="../../../../net/sf/saxon/value/UntypedAtomicValue.html" title="class in net.sf.saxon.value">UntypedAtomicValue</A>, <A HREF="../../../../net/sf/saxon/value/YearMonthDurationValue.html" title="class in net.sf.saxon.value">YearMonthDurationValue</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>GroundedValue<T extends <A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A>></B><DT>extends <A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A><T></DL>
</PRE>
<P>
A value that exists in memory and that can be directly addressed
<P>
<P>
<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>
</TABLE>
<A NAME="fields_inherited_from_class_net.sf.saxon.om.ValueRepresentation"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from interface net.sf.saxon.om.<A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html#EMPTY_VALUE_ARRAY">EMPTY_VALUE_ARRAY</A></CODE></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> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/GroundedValue.html#getLength()">getLength</A></B>()</CODE>
<BR>
Get the size of the value (the number of items)</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/om/GroundedValue.html" title="type parameter in GroundedValue">T</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/GroundedValue.html#itemAt(int)">itemAt</A></B>(int n)</CODE>
<BR>
Get the n'th item in the value, counting from 0</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/om/GroundedValue.html" title="interface in net.sf.saxon.om">GroundedValue</A><<A HREF="../../../../net/sf/saxon/om/GroundedValue.html" title="type parameter in GroundedValue">T</A>></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/GroundedValue.html#subsequence(int, int)">subsequence</A></B>(int start,
int length)</CODE>
<BR>
Get a subsequence of the value</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_net.sf.saxon.om.ValueRepresentation"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface net.sf.saxon.om.<A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html#getStringValue()">getStringValue</A>, <A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html#getStringValueCS()">getStringValueCS</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="itemAt(int)"><!-- --></A><H3>
itemAt</H3>
<PRE>
<A HREF="../../../../net/sf/saxon/om/GroundedValue.html" title="type parameter in GroundedValue">T</A> <B>itemAt</B>(int n)</PRE>
<DL>
<DD>Get the n'th item in the value, counting from 0
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>n</CODE> - the index of the required item, with 0 representing the first item in the sequence
<DT><B>Returns:</B><DD>the n'th item if it exists, or null otherwise</DL>
</DD>
</DL>
<HR>
<A NAME="subsequence(int, int)"><!-- --></A><H3>
subsequence</H3>
<PRE>
<A HREF="../../../../net/sf/saxon/om/GroundedValue.html" title="interface in net.sf.saxon.om">GroundedValue</A><<A HREF="../../../../net/sf/saxon/om/GroundedValue.html" title="type parameter in GroundedValue">T</A>> <B>subsequence</B>(int start,
int length)</PRE>
<DL>
<DD>Get a subsequence of the value
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>start</CODE> - the index of the first item to be included in the result, counting from zero.
A negative value is taken as zero. If the value is beyond the end of the sequence, an empty
sequence is returned<DD><CODE>length</CODE> - the number of items to be included in the result. Specify Integer.MAX_VALUE to
get the subsequence up to the end of the base sequence. If the value is negative, an empty sequence
is returned. If the value goes off the end of the sequence, the result returns items up to the end
of the sequence
<DT><B>Returns:</B><DD>the required subsequence. If min is</DL>
</DD>
</DL>
<HR>
<A NAME="getLength()"><!-- --></A><H3>
getLength</H3>
<PRE>
int <B>getLength</B>()</PRE>
<DL>
<DD>Get the size of the value (the number of items)
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the number of items in the sequence</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/om/FunctionItem.html" title="interface in net.sf.saxon.om"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/om/InscopeNamespaceResolver.html" title="class in net.sf.saxon.om"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/om/GroundedValue.html" target="_top"><B>FRAMES</B></A>
<A HREF="GroundedValue.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>
