Package net.sf.saxon.event
Interface LocationProvider
-
- All Known Subinterfaces:
InstructionInfo
,SaxonLocator
,SourceLocationProvider
- All Known Implementing Classes:
AbsentExtensionElement
,AdjacentTextNodeMerger
,Adjust
,Aggregate
,AnalyzeString
,AndExpression
,ApplyImports
,ApplyTemplates
,ArithmeticExpression
,ArithmeticExpression10
,Assignation
,AtomicSequenceConverter
,Atomizer
,AttributeCreator
,AttributeSet
,Available
,Average
,AxisExpression
,BaseURI
,BinaryExpression
,Block
,BooleanExpression
,BooleanFn
,CallTemplate
,CardinalityChecker
,CastableExpression
,CastExpression
,CastingExpression
,Choose
,ClauseInfo
,CodepointEqual
,CodepointsToString
,CollatingFunction
,Collection
,Comment
,Compare
,CompareToIntegerConstant
,CompileTimeFunction
,Component
,ComputedAttribute
,ComputedElement
,Concat
,ConditionalSorter
,Contains
,ContextItemExpression
,Copy
,CopyOf
,Count
,Current
,CurrentDateTime
,CurrentGroup
,CurrentGroupingKey
,CurrentItemExpression
,Data
,DateTimeConstructor
,DeepEqual
,DefaultCollation
,DistinctValues
,Doc
,DocAvailable
,Doctype
,DocumentFn
,DocumentInstr
,DocumentSorter
,DocumentUriFn
,DOMSender
,EagerLetExpression
,ElementAvailable
,ElementCreator
,Empty
,EmptyTextNodeRemover
,EndsWith
,Error
,ErrorExpression
,EscapeURI
,Exists
,Expression
,ExpressionLocation
,ExpressionParser.TemporaryContainer
,ExtensionInstruction
,FilterExpression
,FirstItemExpression
,FixedAttribute
,FixedElement
,FLWORExpression
,ForceCase
,ForEach
,ForEachGroup
,ForExpression
,FormatDate
,FormatNumber
,FunctionArity
,FunctionAvailable
,FunctionCall
,FunctionName
,GeneralComparison
,GeneralComparison10
,GeneralComparison20
,GenerateId
,GlobalParam
,GlobalVariable
,HomogeneityChecker
,Id
,IdentityComparison
,Idref
,IndexOf
,InScopePrefixes
,Insert
,InstanceOfExpression
,Instruction
,InstructionDetails
,IntegerRangeTest
,IntegratedFunctionCall
,IsLastExpression
,ItemChecker
,KeyDefinition
,KeyFn
,Lang
,Last
,LastItemExpression
,LetExpression
,Literal
,LiteralResultElement
,LocalNameFn
,LocalParamBlock
,LocalParamSetter
,LocalVariableReference
,LocationCopier
,LocationMap
,Matches
,Message
,Minimax
,NameFn
,NamespaceConstructor
,NamespaceForPrefix
,NamespaceUriFn
,NegateExpression
,NextMatch
,Nilled
,NodeNameFn
,NormalizeSpace
,NormalizeUnicode
,NotFn
,NumberFn
,NumberInstruction
,OrExpression
,ParentNodeConstructor
,ParentNodeExpression
,PatternSponsor
,Position
,Procedure
,ProcessingInstruction
,ProcessRegexMatchInstruction
,Put
,QNameFn
,QuantifiedExpression
,RangeExpression
,RegexGroup
,Remove
,Replace
,ResolveQName
,ResolveURI
,ResultDocument
,Reverse
,Root
,RootExpression
,Rounding
,SimpleExpression
,SimpleNodeConstructor
,SimpleStepExpression
,SingleItemFilter
,SingleNodeExpression
,SingletonAtomizer
,SingletonIntersectExpression
,SlashExpression
,SortExpression
,SQLClose
,SQLColumn
,SQLConnect
,SQLDelete
,SQLExecute
,SQLInsert
,SQLQuery
,SQLUpdate
,StartsWith
,StaticBaseURI
,StaxBridge
,StaxToEventBridge
,StringFn
,StringJoin
,StringLength
,StringLiteral
,StringToCodepoints
,StyleElement
,Subsequence
,Substring
,SubstringAfter
,SubstringBefore
,Sum
,SuppliedParameterReference
,SystemFunction
,SystemProperty
,TailCallLoop
,TailExpression
,Template
,TinyTreeEventIterator
,Tokenize
,Trace
,TraceExpression
,Translate
,TreatFn
,TupleExpression
,TypeAvailable
,UnaryExpression
,Unordered
,UnparsedEntity
,UnparsedText
,UnparsedTextAvailable
,UnparsedTextLines
,UriCollection
,UseAttributeSets
,UserFunction
,UserFunctionCall
,ValueComparison
,ValueOf
,VariableReference
,VennExpression
,XPathFunctionCall
,XQueryFunction
,XSLAnalyzeString
,XSLApplyImports
,XSLApplyTemplates
,XSLAttribute
,XSLAttributeSet
,XSLCallTemplate
,XSLCharacterMap
,XSLChoose
,XSLComment
,XSLCopy
,XSLCopyOf
,XSLDecimalFormat
,XSLDocument
,XSLElement
,XSLFallback
,XSLForEach
,XSLForEachGroup
,XSLFunction
,XSLGeneralIncorporate
,XSLGeneralVariable
,XSLIf
,XSLImport
,XSLImportSchema
,XSLInclude
,XSLKey
,XSLLeafNodeConstructor
,XSLMatchingSubstring
,XSLMessage
,XSLNamespace
,XSLNamespaceAlias
,XSLNextMatch
,XSLNumber
,XSLOtherwise
,XSLOutput
,XSLOutputCharacter
,XSLParam
,XSLPerformSort
,XSLPreserveSpace
,XSLProcessingInstruction
,XSLResultDocument
,XSLSequence
,XSLSort
,XSLSortOrMergeKey
,XSLStylesheet
,XSLTemplate
,XSLText
,XSLValueOf
,XSLVariable
,XSLVariableDeclaration
,XSLWhen
,XSLWithParam
public interface LocationProvider
LocationProvider: this interface represents an object that provides the location of elements in a source document or instructions in a stylesheet or query. A locationProvider may be passed down the Receiver pipeline as part of the PipelineConfiguration object; on the input pipeline, this will be aSaxonLocator
object, on the output pipeline, it will be aLocationMap
A LocationProvider that represents locations in the source document from which the events are derived (as distinct from locations in a query or stylesheet of the instructions causing the events) will also implement the marker interfaceSourceLocationProvider
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getColumnNumber(long locationId)
Get the column number within the document, entity, or module containing a particular locationint
getLineNumber(long locationId)
Get the line number within the document, entity or module containing a particular locationjava.lang.String
getSystemId(long locationId)
Get the URI of the document, entity, or module containing a particular location
-
-
-
Method Detail
-
getSystemId
java.lang.String getSystemId(long locationId)
Get the URI of the document, entity, or module containing a particular location- Parameters:
locationId
- identifier of the location in question (as passed down the Receiver pipeline)- Returns:
- the URI of the document, XML entity or module. For a SourceLocationProvider this will be the URI of the document or entity (the URI that would be the base URI if there were no xml:base attributes). In other cases it may identify the query or stylesheet module currently being executed.
-
getLineNumber
int getLineNumber(long locationId)
Get the line number within the document, entity or module containing a particular location- Parameters:
locationId
- identifier of the location in question (as passed down the Receiver pipeline)- Returns:
- the line number within the document, entity or module, or -1 if no information is available.
-
getColumnNumber
int getColumnNumber(long locationId)
Get the column number within the document, entity, or module containing a particular location- Parameters:
locationId
- identifier of the location in question (as passed down the Receiver pipeline)- Returns:
- the column number within the document, entity, or module, or -1 if this is not available
-
-