net.sf.saxon.event
Interface LocationProvider
- All Known Subinterfaces:
- InstructionInfo, SaxonLocator, SourceLocationProvider
- All Known Implementing Classes:
- AbsentExtensionElement, Adjust, Aggregate, AnalyzeString, ApplyImports, ApplyTemplates, ArithmeticExpression, ArithmeticExpression10, Assign, Assignation, AtomicMappingExpression, AtomicSequenceConverter, Atomizer, AttributeCreator, AttributeSet, Available, AxisExpression, BaseURI, BinaryExpression, Block, BooleanExpression, BooleanFn, CallTemplate, CardinalityChecker, CastableExpression, CastExpression, Choose, CodepointEqual, CodepointsToString, CollatingFunction, Collection, Comment, Compare, CompareToIntegerConstant, CompileTimeFunction, Component, ComputedAttribute, ComputedElement, Concat, ConditionalSorter, Contains, ContextItemExpression, Copy, CopyOf, Current, CurrentDateTime, CurrentGroup, CurrentItemExpression, Data, DateTimeConstructor, DeepEqual, DefaultCollation, DistinctValues, Doc, DocAvailable, Doctype, Document, DocumentInstr, DocumentSender, DocumentSorter, DOMSender, EagerLetExpression, ElementCreator, EndsWith, Error, ErrorExpression, EscapeURI, Existence, Expression, ExpressionLocation, ExpressionParser.TemporaryContainer, ExtensionInstruction, FilterExpression, FirstItemExpression, FixedAttribute, FixedElement, ForceCase, ForEach, ForEachGroup, ForExpression, FormatDate, FormatNumber, FunctionArity, FunctionCall, FunctionName, GeneralComparison, GeneralComparison10, GeneralVariable, GlobalParam, GlobalVariable, Id, IdentityComparison, Idref, IndexOf, InScopePrefixes, Insert, InstanceOfExpression, Instruction, InstructionDetails, IntegerRangeTest, IntegratedFunctionCall, IsLastExpression, ItemChecker, KeyDefinition, KeyFn, Lang, Last, LastItemExpression, LazyExpression, LetExpression, Literal, LiteralResultElement, LocalParam, LocalVariable, LocalVariableReference, LocationCopier, LocationMap, Matches, Message, Minimax, NamePart, NamespaceConstructor, NamespaceForPrefix, NegateExpression, NextMatch, Nilled, NormalizeSpace, NormalizeUnicode, NumberFn, NumberInstruction, NumericPromoter, ParentNodeConstructor, ParentNodeExpression, PartialApply, PathExpression, PatternMatchExpression, PatternSponsor, Position, Procedure, ProcessingInstruction, PromoteToDouble, PromoteToFloat, Put, QNameFn, QuantifiedExpression, QuerySimpleContentConstructor, RangeExpression, RegexGroup, Remove, Replace, ResolveQName, ResolveURI, ResultDocument, Reverse, Root, RootExpression, Rounding, SimpleContentConstructor, SimpleExpression, SimpleNodeConstructor, SingleNodeExpression, SingletonAtomizer, SingletonComparison, SlashExpression, SortExpression, SQLClose, SQLColumn, SQLConnect, SQLDelete, SQLInsert, SQLQuery, SQLUpdate, StartsWith, StaticBaseURI, StaxBridge, StaxToEventBridge, StringFn, StringJoin, StringLength, StringLiteral, StringToCodepoints, StyleElement, Subsequence, Substring, SubstringAfter, SubstringBefore, SuppliedParameterReference, SystemFunction, SystemProperty, TailCallLoop, TailExpression, Template, TinyTreeEventIterator, Tokenize, Trace, TraceExpression, TraceInstruction, TraceWrapper, Translate, TreatFn, TupleExpression, TupleSorter, UnaryExpression, Unordered, UnparsedEntity, UnparsedText, UntypedAtomicConverter, UseAttributeSets, UserFunction, UserFunctionCall, ValueComparison, ValueOf, VariableReference, VennExpression, While, WithParam, 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, XSLMatchingSubstring, XSLMessage, XSLNamespace, XSLNamespaceAlias, XSLNextMatch, XSLNumber, XSLOtherwise, XSLOutput, XSLOutputCharacter, XSLParam, XSLPerformSort, XSLPreserveSpace, XSLProcessingInstruction, XSLResultDocument, XSLSequence, XSLSort, XSLStringConstructor, 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 a SaxonLocator
object,
on the output pipeline, it will be a LocationMap
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 interface SourceLocationProvider
Method Summary |
int |
getColumnNumber(long locationId)
Get the column number within the document, entity, or module containing a particular location |
int |
getLineNumber(long locationId)
Get the line number within the document, entity or module containing a particular location |
String |
getSystemId(long locationId)
Get the URI of the document, entity, or module containing a particular location |
getSystemId
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