Interface GroundedValue
- All Superinterfaces:
Sequence
- All Known Subinterfaces:
AnyExternalObject
,AtomicSequence
,FunctionItem
,Item
,MutableNodeInfo
,NodeInfo
,SiblingCountingNode
,SteppingNode
,VirtualNode
- All Known Implementing Classes:
Abs
,AbsentExtensionElement
,AbstractArrayItem
,AbstractFunction
,AbstractNodeWrapper
,AbstractVirtualNode
,AccessorFn
,AccessorFn.DayFromDate
,AccessorFn.DayFromDateTime
,AccessorFn.DaysFromDuration
,AccessorFn.HoursFromDateTime
,AccessorFn.HoursFromDuration
,AccessorFn.HoursFromTime
,AccessorFn.LocalNameFromQName
,AccessorFn.MinutesFromDateTime
,AccessorFn.MinutesFromDuration
,AccessorFn.MinutesFromTime
,AccessorFn.MonthFromDate
,AccessorFn.MonthFromDateTime
,AccessorFn.MonthsFromDuration
,AccessorFn.NamespaceUriFromQName
,AccessorFn.PrefixFromQName
,AccessorFn.SecondsFromDateTime
,AccessorFn.SecondsFromDuration
,AccessorFn.SecondsFromTime
,AccessorFn.TimezoneFromDate
,AccessorFn.TimezoneFromDateTime
,AccessorFn.TimezoneFromTime
,AccessorFn.YearFromDate
,AccessorFn.YearFromDateTime
,AccessorFn.YearsFromDuration
,AccumulatorFn
,AccumulatorFn.AccumulatorAfter
,AccumulatorFn.AccumulatorBefore
,Adjust_1
,Adjust_2
,Aggregate
,AllDifferent
,AllEqual
,AnalyzeStringFn
,AnalyzeUri
,AnnotationParent
,AnyURIValue
,ApplyFn
,ArrayFunctionSet.ArrayAppend
,ArrayFunctionSet.ArrayBuild
,ArrayFunctionSet.ArrayEmpty
,ArrayFunctionSet.ArrayExists
,ArrayFunctionSet.ArrayFilter
,ArrayFunctionSet.ArrayFlatten
,ArrayFunctionSet.ArrayFoldLeft
,ArrayFunctionSet.ArrayFoldRight
,ArrayFunctionSet.ArrayFoot
,ArrayFunctionSet.ArrayForEach
,ArrayFunctionSet.ArrayForEachPair
,ArrayFunctionSet.ArrayFromSequence
,ArrayFunctionSet.ArrayGeneratingFunction
,ArrayFunctionSet.ArrayGet
,ArrayFunctionSet.ArrayHead
,ArrayFunctionSet.ArrayIndexWhere
,ArrayFunctionSet.ArrayInsertBefore
,ArrayFunctionSet.ArrayJoin
,ArrayFunctionSet.ArrayMembers
,ArrayFunctionSet.ArrayOfMembers
,ArrayFunctionSet.ArrayPut
,ArrayFunctionSet.ArrayRemove
,ArrayFunctionSet.ArrayReplace
,ArrayFunctionSet.ArrayReverse
,ArrayFunctionSet.ArraySize
,ArrayFunctionSet.ArraySlice
,ArrayFunctionSet.ArraySplit
,ArrayFunctionSet.ArraySubarray
,ArrayFunctionSet.ArrayTail
,ArrayFunctionSet.ArrayToSequence
,ArrayFunctionSet.ArrayTrunk
,ArrayItem
,ArraySort
,AtomicArray
,AtomicConstructorFunction
,AtomicEqual
,AtomicValue
,AttributeImpl
,AvailableEnvironmentVariables
,AvailableSystemProperties
,Average
,AxiomAttributeWrapper
,AxiomDocumentNodeWrapper
,AxiomElementNodeWrapper
,AxiomLeafNodeWrapper
,AxiomParentNodeWrapper
,Base64BinaryValue
,BaseUri_1
,BigDecimalValue
,BigIntegerValue
,Bindery.FailureValue
,BooleanFn
,BooleanValue
,BuildURI
,CalendarValue
,CallableFunction
,Ceiling
,CharactersFn
,CharactersFn
,CharFn
,CodepointEqual
,CodepointsToString
,CoercedFunction
,CollatingFunctionFixed
,CollatingFunctionFree
,CollationKeyFn
,CollectionFn
,CommentImpl
,CompactStringValue
,Compare
,CompileQuery
,CompileStylesheet
,CompileXPath
,Concat
,Concat31
,ConstantFunction
,ConstantFunction.False
,ConstantFunction.True
,Contains
,ContainsToken
,ContextAccessorFunction
,ContextItemAccessorFunction
,ContextItemAccessorFunction.Number_0
,ContextItemAccessorFunction.StringAccessor
,CopyOfFn
,Count
,Current
,CurrentGroup
,CurrentGroupingKey
,CurrentMergeGroup
,CurrentMergeKey
,CurrentOutputUri
,CurriedFunction
,Data_1
,DataElement
,DateTimeConstructor
,DateTimeValue
,DateValue
,DayTimeDurationValue
,DecimalDivide
,DecimalValue
,DecodeFromURI
,DeepEqual
,DelegatingArrayItem
,DelegatingMapItem
,DictionaryMap
,DistinctValues
,Doc
,Doc_2
,DocAvailable
,DocumentFn
,DocumentImpl
,DocumentUri_1
,DOM4JNodeWrapper
,DominoAttr
,DominoNode
,DOMNodeWrapper
,DoubleValue
,DuplicateValues
,DurationValue
,DynamicContextAccessor
,DynamicContextAccessor.CurrentDate
,DynamicContextAccessor.CurrentDateTime
,DynamicContextAccessor.CurrentTime
,DynamicContextAccessor.DefaultLanguage
,DynamicContextAccessor.ImplicitTimezone
,ElementAvailable
,ElementImpl
,Empty
,EmptyAtomicSequence
,EmptySequence
,EncodeForUri
,EndsWith
,EnvironmentVariable
,EQName
,Error
,EscapeHtmlUri
,EscapeNCName
,Eval
,Evaluate
,EveryFn
,Exists
,ExpandedQNameFn
,EXPathBinaryFunctionSet.BinaryAnd
,EXPathBinaryFunctionSet.BinaryBin
,EXPathBinaryFunctionSet.BinaryDecodeString
,EXPathBinaryFunctionSet.BinaryEncodeString
,EXPathBinaryFunctionSet.BinaryFind
,EXPathBinaryFunctionSet.BinaryFromOctets
,EXPathBinaryFunctionSet.BinaryHex
,EXPathBinaryFunctionSet.BinaryInsertBefore
,EXPathBinaryFunctionSet.BinaryJoin
,EXPathBinaryFunctionSet.BinaryLength
,EXPathBinaryFunctionSet.BinaryNot
,EXPathBinaryFunctionSet.BinaryOctal
,EXPathBinaryFunctionSet.BinaryOr
,EXPathBinaryFunctionSet.BinaryPackDouble
,EXPathBinaryFunctionSet.BinaryPackFloat
,EXPathBinaryFunctionSet.BinaryPackInteger
,EXPathBinaryFunctionSet.BinaryPadLeft
,EXPathBinaryFunctionSet.BinaryPadRight
,EXPathBinaryFunctionSet.BinaryPart
,EXPathBinaryFunctionSet.BinaryShift
,EXPathBinaryFunctionSet.BinaryToOctets
,EXPathBinaryFunctionSet.BinaryUnpackDouble
,EXPathBinaryFunctionSet.BinaryUnpackFloat
,EXPathBinaryFunctionSet.BinaryUnpackInteger
,EXPathBinaryFunctionSet.BinaryUnpackUnsignedInteger
,EXPathBinaryFunctionSet.BinaryVersion
,EXPathBinaryFunctionSet.BinaryXor
,EXPathFileFunctionSet.FileAppend
,EXPathFileFunctionSet.FileAppendBinary
,EXPathFileFunctionSet.FileAppendText
,EXPathFileFunctionSet.FileAppendTextLines
,EXPathFileFunctionSet.FileBaseDir
,EXPathFileFunctionSet.FileChildren
,EXPathFileFunctionSet.FileCopy
,EXPathFileFunctionSet.FileCreateDir
,EXPathFileFunctionSet.FileCreateTempDir
,EXPathFileFunctionSet.FileCreateTempFile
,EXPathFileFunctionSet.FileCurrentDir
,EXPathFileFunctionSet.FileDelete
,EXPathFileFunctionSet.FileDirSeparator
,EXPathFileFunctionSet.FileExists
,EXPathFileFunctionSet.FileIsDir
,EXPathFileFunctionSet.FileIsFile
,EXPathFileFunctionSet.FileLastModified
,EXPathFileFunctionSet.FileLineSeparator
,EXPathFileFunctionSet.FileList
,EXPathFileFunctionSet.FileMove
,EXPathFileFunctionSet.FileName
,EXPathFileFunctionSet.FileParent
,EXPathFileFunctionSet.FilePathSeparator
,EXPathFileFunctionSet.FilePathToNative
,EXPathFileFunctionSet.FilePathToUri
,EXPathFileFunctionSet.FileReadBinary
,EXPathFileFunctionSet.FileReadText
,EXPathFileFunctionSet.FileReadTextLines
,EXPathFileFunctionSet.FileResolvePath
,EXPathFileFunctionSet.FileSize
,EXPathFileFunctionSet.FileTempDir
,EXPathFileFunctionSet.FileWrite
,EXPathFileFunctionSet.FileWriteBinary
,EXPathFileFunctionSet.FileWriteText
,EXPathFileFunctionSet.FileWriteTextLines
,ExpressionFn
,ExsltCommonFunctionSet.NodeSetFn
,ExsltCommonFunctionSet.ObjectTypeFn
,ExtensionInstruction
,FilterFn
,FleetingDocumentNode
,FleetingElementNode
,FleetingNode
,FleetingParentNode
,FloatValue
,Floor
,FoldingFunction
,FoldLeftFn
,FoldRightFn
,FootFn
,ForEachFn
,ForEachPairFn
,FormatDate
,FormatInteger
,FormatNumber
,FunctionAnnotations
,FunctionArity
,FunctionAvailable
,FunctionLookup
,FunctionName
,GDateValue
,GDayValue
,GenerateId_1
,GMonthDayValue
,GMonthValue
,GroupStarting
,GYearMonthValue
,GYearValue
,HasChildren_1
,HashTrieMap
,HeadFn
,HexBinaryValue
,HighestOrLowest
,HighestOrLowest
,IdentityFn
,Idref
,ImmutableArrayItem
,Index
,IndexedValue
,IndexOf
,IndexWhere
,Innermost
,InScopeNamespacesFn
,InScopePrefixes
,InsertBefore
,Int64Value
,IntegerRange
,IntegerValue
,Intersperse
,IriToUri
,IsNaN
,ItemsAt
,ItemsEnding
,ItemsEnding.ItemsBefore
,ItemsEnding.ItemsUntil
,ItemsStarting
,ItemsStarting.ItemsAfter
,ItemsStarting.ItemsFrom
,IterateWhileFn
,IXSLFunctionSet.Call
,IXSLFunctionSet.Eval
,IXSLFunctionSet.ScheduleActionFn
,IXSLFunctionSet.Source
,IXSLFunctionSet.Stub
,IXSLPromise
,IXSLRemoveAttribute
,IXSLRemoveProperty
,IXSLScheduleAction
,IXSLSetAttribute
,IXSLSetProperty
,IXSLSetStyle
,JDOM2NodeWrapper
,JsonDoc
,JsonToXMLFn
,KeyFn
,KeyMap
,Lang
,LastModified
,Leading
,ListCastableFunction
,ListConstructorFunction
,LiteralResultElement
,LoadXqueryModule
,LocalName_1
,LowerCase
,MapCreate
,MapFunctionSet.MapBuild
,MapFunctionSet.MapContains
,MapFunctionSet.MapEntries
,MapFunctionSet.MapEntry
,MapFunctionSet.MapFilter
,MapFunctionSet.MapFind
,MapFunctionSet.MapForEach
,MapFunctionSet.MapGet
,MapFunctionSet.MapKeys
,MapFunctionSet.MapMerge
,MapFunctionSet.MapOfPairs
,MapFunctionSet.MapPair
,MapFunctionSet.MapPairs
,MapFunctionSet.MapPut
,MapFunctionSet.MapRemove
,MapFunctionSet.MapSize
,MapItem
,MapSearch
,MapUntypedContains
,Matches
,MathFunctionSet.Atan2Fn
,MathFunctionSet.PiFn
,MathFunctionSet.PowFn
,MathFunctionSet.TrigFn1
,MemoFunction
,MemoFunction.NodeSurrogate
,MessageCount
,Minimax
,Minimax.Max
,Minimax.Min
,Name_1
,NamespaceForPrefix
,NamespaceNode
,NamespaceUriFn_1
,NewAttribute
,NewComment
,NewDocument
,NewElement
,NewNamespace
,NewProcessingInstruction
,NewText
,Nilled_1
,NodeImpl
,NodeName_1
,NormalizeSpace_1
,NormalizeUnicode
,NotationValue
,NotFn
,Number_1
,NumericValue
,ObjectMap
,ObjectValue
,One
,OneOrMore
,OpFn
,OriginalFunction
,Orphan
,Outermost
,Parcel
,ParcelFn
,ParentNodeImpl
,Parse
,ParseHtml
,ParseIetfDate
,ParseInteger
,ParseJsonFn
,ParseQNameFn
,ParseURI
,ParseXml
,ParseXmlFragment
,ParseXPath
,Partition
,Parts
,Path_1
,PedigreeArrayItem
,PedigreeFn
,PedigreeMapItem
,PositionAndLast
,PositionAndLast.Last
,PositionAndLast.Position
,ProcInstImpl
,Put
,QNameFn
,QNameValue
,QualifiedNameValue
,QueryFn
,RandomNumberGenerator
,RangeKey
,ReadBinaryResource
,RebasedNode
,RegexFunction
,RegexFunctionSansFlags
,RegexGroup
,Remove
,Replace
,ReplaceWith
,Replicate
,ResolveQName
,ResolveURI
,Reverse
,Root_1
,Round
,RoundHalfToEven
,SaxonAssign
,SaxonChange
,SaxonDeepEqual
,SaxonDeepUpdate
,SaxonDelete
,SaxonDo
,SaxonDoctype
,SaxonEntityRef
,SaxonImportQuery
,SaxonInsert
,SaxonParam
,SaxonPreprocess
,SaxonRename
,SaxonReplace
,SaxonSlice
,SaxonTabulateMaps
,SaxonUpdate
,SaxonWhile
,ScalarSystemFunction
,SchemaElement
,SchemaFn
,SchemaTypeFn
,SearchableValue
,SendMail
,SequenceExtent
,SequenceExtent.Of
,SequenceMatching
,SequenceMatching.ContainsSequence
,SequenceMatching.EndsWithSequence
,SequenceMatching.StartsWithSequence
,Serialize
,Serialize
,SimpleArrayItem
,SingleEntryMap
,Slice
,SnapshotFn
,SnapshotNode
,SomeFn
,Sort_1
,Sort_2
,Sort_3
,SpaceStrippedNode
,SQLClose
,SQLColumn
,SQLConnect
,SQLConnectFn
,SQLDelete
,SQLDeleteFn
,SQLExecute
,SQLExecuteFn
,SQLInsert
,SQLInsertFn
,SQLPreparedQueryFn
,SQLPreparedStatementFn
,SQLQuery
,SQLQueryFn
,SQLTableFn
,SQLUpdate
,SQLUpdateFn
,StartsWith
,StaticBaseUri
,StaticContextAccessor
,StaticContextAccessor.DefaultCollation
,StreamableUserFunction
,StreamAvailable
,StreamFn
,String_1
,StringJoin
,StringLength_1
,StringToCodepoints
,StringValue
,StyleElement
,Subsequence_2
,Subsequence_3
,Substring
,SubstringAfter
,SubstringBefore
,Sum
,SuperId
,SuperId.ElementWithId
,SuperId.Id
,SystemFunction
,SystemFunctionWithBoundContextItem
,SystemProperty
,TailFn
,TextFragmentValue
,TextImpl
,TextValueTemplateNode
,TimestampFn
,TimeValue
,TinyAttributeImpl
,TinyDocumentImpl
,TinyElementImpl
,TinyNodeImpl
,TinyParentNodeImpl
,TinyTextImpl
,TinyTextualElement
,TinyTextualElement.TinyTextualElementText
,Tokenize_1
,Tokenize_3
,Trace
,TransformFn
,TransformFn
,TransitiveClosure
,Translate
,TreatFn
,TreatFn.ExactlyOne
,TreatFn.OneOrMore
,TreatFn.ZeroOrOne
,Trunk
,Tuple
,TypeAvailable
,TypeStrippedNode
,UnescapeNCName
,Unindexed
,UnionCastableFunction
,UnionConstructorFunction
,UnknownElement
,Unordered
,UnparcelFn
,UnparsedEntity
,UnparsedEntity.UnparsedEntityPublicId
,UnparsedEntity.UnparsedEntityUri
,UnparsedText
,UnparsedTextAvailable
,UnparsedTextFunction
,UnparsedTextLines
,UnresolvedXQueryFunctionItem
,UpperCase
,UriCollection
,URIFunctions
,UserFunction
,UserFunctionReference.BoundUserFunction
,ValidateFn
,VendorFunctionSetHE.ArrayAsSequenceOfMaps
,VendorFunctionSetHE.ConcatenateSequences
,VendorFunctionSetHE.DynamicErrorInfoFn
,VendorFunctionSetHE.HasLocalNamespaces
,VendorFunctionSetHE.HasUniformNamespaces
,VendorFunctionSetHE.IsWholeNumberFn
,VendorFunctionSetHE.MapAsSequenceOfMaps
,VendorFunctionSetHE.YesNoBoolean
,VendorFunctionSetPE.AdjustToCivilTime
,VendorFunctionSetPE.Base64BinaryToOctets
,VendorFunctionSetPE.Base64BinaryToString
,VendorFunctionSetPE.ColumnNumber
,VendorFunctionSetPE.ConfigurationFn
,VendorFunctionSetPE.ContextFn
,VendorFunctionSetPE.ControllerFn
,VendorFunctionSetPE.CurrentModeName
,VendorFunctionSetPE.DiscardDocument
,VendorFunctionSetPE.GetContext
,VendorFunctionSetPE.GetPseudoAttribute
,VendorFunctionSetPE.HasSameNodes
,VendorFunctionSetPE.HexBinaryToOctets
,VendorFunctionSetPE.HexBinaryToString
,VendorFunctionSetPE.InSummerTime
,VendorFunctionSetPE.IsDefaulted
,VendorFunctionSetPE.LineNumber
,VendorFunctionSetPE.NamespaceNodeFn
,VendorFunctionSetPE.OctetsToBase64Binary
,VendorFunctionSetPE.OctetsToHexBinary
,VendorFunctionSetPE.ParseDateTime
,VendorFunctionSetPE.PrintStack
,VendorFunctionSetPE.StringToBase64BinaryFn
,VendorFunctionSetPE.StringToHexBinaryFn
,VendorFunctionSetPE.StringToUTF8
,VendorFunctionSetPE.SystemId
,VendorFunctionSetPE.TunnelParamsFn
,VendorFunctionSetPE.TypeAnnotationFn
,VendorFunctionSetPE.UnparsedEntities
,VendorFunctionSetPE.ValidCharacter
,VirtualCopy
,VirtualUntypedCopy
,VoidFn
,WhitespaceTextImpl
,WithPedigree
,XdmToJsonFn
,XMLToJsonFn
,XOMDocumentWrapper
,XOMNodeWrapper
,XQueryFn
,XSDAlternative
,XSDAnnotation
,XSDAny
,XSDAnyAttribute
,XSDAssert
,XSDAttribute
,XSDAttributeGroup
,XSDComplexContent
,XSDComplexContentRestriction
,XSDComplexType
,XSDCompositor
,XSDDefaultOpenContent
,XSDDocumentation
,XSDElement
,XSDExtension
,XSDFacet
,XSDFieldOrSelector
,XSDGroup
,XSDIdentityConstraint
,XSDImport
,XSDInclude
,XSDList
,XSDNotation
,XSDOpenContent
,XSDOverride
,XSDRedefine
,XSDSchema
,XSDSimpleContent
,XSDSimpleContentRestriction
,XSDSimpleType
,XSDSimpleTypeRestriction
,XSDUnion
,XSLAccept
,XSLAcceptExpose
,XSLAccumulator
,XSLAccumulatorRule
,XSLAnalyzeString
,XSLApplyImports
,XSLApplyTemplates
,XSLArray
,XSLArrayMember
,XSLAssert
,XSLAttribute
,XSLAttributeSet
,XSLBreak
,XSLBreakOrContinue
,XSLCallTemplate
,XSLCatch
,XSLCharacterMap
,XSLChoose
,XSLChooseOrSwitch
,XSLComment
,XSLContextItem
,XSLCopy
,XSLCopyOf
,XSLDecimalFormat
,XSLDocument
,XSLElement
,XSLEvaluate
,XSLExpose
,XSLFallback
,XSLForEach
,XSLForEachGroup
,XSLFork
,XSLFunction
,XSLGeneralIncorporate
,XSLGeneralVariable
,XSLGlobalContextItem
,XSLGlobalParam
,XSLGlobalVariable
,XSLIf
,XSLImport
,XSLImportSchema
,XSLInclude
,XSLItemType
,XSLIterate
,XSLKey
,XSLLeafNodeConstructor
,XSLLocalParam
,XSLLocalVariable
,XSLMap
,XSLMapEntry
,XSLMatchingSubstring
,XSLMerge
,XSLMergeAction
,XSLMergeKey
,XSLMergeSource
,XSLMessage
,XSLMode
,XSLModuleRoot
,XSLNamespace
,XSLNamespaceAlias
,XSLNextIteration
,XSLNextMatch
,XSLNumber
,XSLOnCompletion
,XSLOnEmpty
,XSLOnNonEmpty
,XSLOtherwise
,XSLOutput
,XSLOutputCharacter
,XSLOverride
,XSLPackage
,XSLPerformSort
,XSLPreserveSpace
,XSLProcessingInstruction
,XSLResultDocument
,XSLSequence
,XSLSort
,XSLSortOrMergeKey
,XSLSourceDocument
,XSLStylesheet
,XSLSwitch
,XSLTemplate
,XSLText
,XSLTry
,XSLUsePackage
,XSLValueOf
,XSLWhen
,XSLWherePopulated
,XSLWithParam
,YearMonthDurationValue
,ZenoSequence
,ZeroOrMore
,ZeroOrOne
- Since:
- 9.5. Generified in 9.9. Generification reverted in 10.0.
-
Method Summary
Modifier and TypeMethodDescriptionGet anIterable
that wraps thisGroundedValue
, allowing it to be used in a Java for-each loop.default GroundedValue
concatenate
(GroundedValue... others) Append two or more grounded values to form a new grounded valuedefault boolean
containsNode
(NodeInfo sought) Determine whether a particular node is present in the valuedefault boolean
Get the effective boolean value of this sequenceint
Get the size of the value (the number of items in the value, considered as a sequence)Get the string value of this sequence, as an instance ofString
.Get the string value of this sequence, as an instance ofUnicodeString
.head()
Get the first item of the sequence.itemAt
(int n) Get the n'th item in the value, counting from zero (0)iterate()
Get an iterator over all the items in the sequence.default GroundedValue
Create aGroundedValue
containing the same items as this Sequence.default GroundedValue
reduce()
Reduce the sequence to its simplest form.subsequence
(int start, int length) Get a subsequence of the valuedefault String
Produce a short representation of the value of the sequence, suitable for use in error messagesMethods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Method Details
-
iterate
SequenceIterator iterate()Get an iterator over all the items in the sequence. This differs from the superclass method in not allowing an exception, either during this method call, or in the subsequent processing of the returned iterator.- Specified by:
iterate
in interfaceSequence
- Returns:
- an iterator (meaning a Saxon
SequenceIterator
rather than a JavaIterator
) over all the items in this Sequence.
-
itemAt
Get the n'th item in the value, counting from zero (0)- Parameters:
n
- the index of the required item, with zero (0) representing the first item in the sequence- Returns:
- the n'th item if it exists, or null if the requested position is out of range
-
head
Item head()Get the first item of the sequence. This differs from the parent interface in not allowing an exception -
subsequence
Get a subsequence of the value- Parameters:
start
- 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 returnedlength
- 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 length goes off the end of the sequence, the result returns items up to the end of the sequence- Returns:
- the required subsequence.
-
getLength
int getLength()Get the size of the value (the number of items in the value, considered as a sequence)- Returns:
- the number of items in the sequence. Note that for a single item, including a map or array, the result is always 1 (one).
-
effectiveBooleanValue
Get the effective boolean value of this sequence- Returns:
- the effective boolean value
- Throws:
XPathException
- if the sequence has no effective boolean value (for example a sequence of two integers)
-
getUnicodeStringValue
Get the string value of this sequence, as an instance ofUnicodeString
. The string value of an item is the result of applying the XPath string() function. The string value of a sequence is the space-separated result of applying the string-join() function using a single space as the separatorThe result of this method is always equivalent to the result of the
getStringValue()
method. Use this method in preference either (a) if you need to use the value in a context where aUnicodeString
is required, or (b) if the underlying value is held as aUnicodeString
, or in a form that is readily converted to aUnicodeString
. This is typically the case (i) when the value is a text or element node in a TinyTree, and (ii) when the value is aStringItem
: that is, an atomic value of typexs:string
.- Returns:
- the string value of the sequence.
- Throws:
XPathException
- if the sequence contains items that have no string value (for example, function items)
-
getStringValue
Get the string value of this sequence, as an instance ofString
. The string value of an item is the result of applying the XPath string() function. The string value of a sequence is the space-separated result of applying the string-join() function using a single space as the separator.The result of this method is always equivalent to the result of the
getUnicodeStringValue()
method. Use this method in preference either (a) if you need to use the value in a context where aString
is required, or (b) if the underlying value is held as aString
, or in a form that is readily converted to aString
. This is typically the case (i) when the value is an attribute node in a TinyTree, or (ii) any kind of node in a third-party tree model such as DOM.- Returns:
- the string value of the sequence.
- Throws:
XPathException
- if the sequence contains items that have no string value (for example, function items)
-
reduce
Reduce the sequence to its simplest form. If the value is an empty sequence, the result will be EmptySequence.getInstance(). If the value is a single atomic value, the result will be an instance of AtomicValue. If the value is a single item of any other kind, the result will be an instance of Item. Otherwise, the result will typically be unchanged.- Returns:
- the simplified sequence
-
materialize
Create aGroundedValue
containing the same items as this Sequence. Since this Sequence is already aGroundedValue
this method returns thisGroundedValue
unchanged.- Specified by:
materialize
in interfaceSequence
- Returns:
- this
GroundedValue
-
toShortString
Produce a short representation of the value of the sequence, suitable for use in error messages- Returns:
- a short representation of the value
-
asIterable
Get anIterable
that wraps thisGroundedValue
, allowing it to be used in a Java for-each loop.- Returns:
- an iterable delivering the contents of this value
-
containsNode
Determine whether a particular node is present in the value- Parameters:
sought
- the sought-after node- Returns:
- true if the sought node is present
- Throws:
XPathException
- This should never happen
-
concatenate
Append two or more grounded values to form a new grounded value- Parameters:
others
- one or more grounded values that are to be concatenated with this one, in order- Returns:
- the concatenation of the supplied sequences (none of which is modified by the operation)
-