| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Interface ILocator |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Interface ILocator |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation "> |
| <meta name="generator" content="docfx 2.56.0.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="benchmark/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Sax.ILocator"> |
| |
| |
| <h1 id="Sax_ILocator" data-uid="Sax.ILocator" class="text-break">Interface ILocator |
| </h1> |
| <div class="markdown level0 summary"><p>Interface for associating a SAX event with a document location.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Sax.html">Sax</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Benchmark.dll</h6> |
| <h5 id="Sax_ILocator_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public interface ILocator</code></pre> |
| </div> |
| <h5 id="Sax_ILocator_remarks"><strong>Remarks</strong></h5> |
| <div class="markdown level0 remarks"><p><em>This module, both source code and documentation, is in the |
| Public Domain, and comes with <strong>NO WARRANTY</strong>.</em> |
| See <a href="http://www.saxproject.org">http://www.saxproject.org</a> |
| for further information. |
| <p> |
| If a SAX parser provides location information to the SAX |
| application, it does so by implementing this interface and then |
| passing an instance to the application using the content |
| handler's <a class="xref" href="Sax.IContentHandler.html#Sax_IContentHandler_SetDocumentLocator_Sax_ILocator_">SetDocumentLocator(ILocator)</a> |
| method.The application can use the |
| object to obtain the location of any other SAX event |
| in the XML source document. |
| <p> |
| Note that the results returned by the object will be valid only |
| during the scope of each callback method: the application |
| will receive unpredictable results if it attempts to use the |
| locator at any other time, or after parsing completes. |
| <p> |
| SAX parsers are not required to supply a locator, but they are |
| very strongly encouraged to do so. If the parser supplies a |
| locator, it must do so before reporting any other document events. |
| If no locator has been set by the time the application receives |
| the <a class="xref" href="Sax.IContentHandler.html#Sax_IContentHandler_StartDocument">StartDocument()</a> |
| event, the application should assume that a locator is not |
| available.</p> |
| </div> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Sax_ILocator_ColumnNumber.md&value=---%0Auid%3A%20Sax.ILocator.ColumnNumber%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/Support/Sax/Locator.cs/#L123">View Source</a> |
| </span> |
| <a id="Sax_ILocator_ColumnNumber_" data-uid="Sax.ILocator.ColumnNumber*"></a> |
| <h4 id="Sax_ILocator_ColumnNumber" data-uid="Sax.ILocator.ColumnNumber">ColumnNumber</h4> |
| <div class="markdown level1 summary"><p>Return the column number where the current document event ends. |
| This is one-based number of Java<pre><code>char</code></pre> values since |
| the last line end. |
| <p> |
| <strong>Warning:</strong> The return value from the method |
| is intended only as an approximation for the sake of diagnostics; |
| it is not intended to provide sufficient information |
| to edit the character content of the original XML document. |
| For example, when lines contain combining character sequences, wide |
| characters, surrogate pairs, or bi-directional text, the value may |
| not correspond to the column in a text editor's display. |
| <p> |
| The return value is an approximation of the column number |
| in the document entity or external parsed entity where the |
| markup triggering the event appears. |
| <p> |
| If possible, the SAX driver should provide the line position |
| of the first character after the text associated with the document |
| event. The first column in each line is column 1. |
| <p> |
| Returns the column number, or -1 if none is available.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">int ColumnNumber { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Sax_ILocator_ColumnNumber_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.ILocator.html#Sax_ILocator_LineNumber">LineNumber</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Sax_ILocator_LineNumber.md&value=---%0Auid%3A%20Sax.ILocator.LineNumber%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/Support/Sax/Locator.cs/#L97">View Source</a> |
| </span> |
| <a id="Sax_ILocator_LineNumber_" data-uid="Sax.ILocator.LineNumber*"></a> |
| <h4 id="Sax_ILocator_LineNumber" data-uid="Sax.ILocator.LineNumber">LineNumber</h4> |
| <div class="markdown level1 summary"><p>Return the line number where the current document event ends. |
| Lines are delimited by line ends, which are defined in |
| the XML specification. |
| <p> |
| <strong>Warning:</strong> The return value from the method |
| is intended only as an approximation for the sake of diagnostics; |
| it is not intended to provide sufficient information |
| to edit the character content of the original XML document. |
| In some cases, these "line" numbers match what would be displayed |
| as columns, and in others they may not match the source text |
| due to internal entity expansion. |
| <p> |
| The return value is an approximation of the line number |
| in the document entity or external parsed entity where the |
| markup triggering the event appears. |
| <p> |
| If possible, the SAX driver should provide the line position |
| of the first character after the text associated with the document |
| event. The first line is line 1. |
| <p> |
| Returns the line number, or -1 if none is available.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">int LineNumber { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Sax_ILocator_LineNumber_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.ILocator.html#Sax_ILocator_ColumnNumber">ColumnNumber</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Sax_ILocator_PublicId.md&value=---%0Auid%3A%20Sax.ILocator.PublicId%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/Support/Sax/Locator.cs/#L54">View Source</a> |
| </span> |
| <a id="Sax_ILocator_PublicId_" data-uid="Sax.ILocator.PublicId*"></a> |
| <h4 id="Sax_ILocator_PublicId" data-uid="Sax.ILocator.PublicId">PublicId</h4> |
| <div class="markdown level1 summary"><p>Gets the public identifier for the current document event. |
| <p> |
| The return value is the public identifier of the document |
| entity or of the external parsed entity in which the markup |
| triggering the event appears. |
| <p> |
| Returns a string containing the public identifier, or null if none is available.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">string PublicId { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Sax_ILocator_PublicId_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.ILocator.html#Sax_ILocator_SystemId">SystemId</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Sax_ILocator_SystemId.md&value=---%0Auid%3A%20Sax.ILocator.SystemId%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/Support/Sax/Locator.cs/#L71">View Source</a> |
| </span> |
| <a id="Sax_ILocator_SystemId_" data-uid="Sax.ILocator.SystemId*"></a> |
| <h4 id="Sax_ILocator_SystemId" data-uid="Sax.ILocator.SystemId">SystemId</h4> |
| <div class="markdown level1 summary"><p>Return the system identifier for the current document event. |
| <p> |
| The return value is the system identifier of the document |
| entity or of the external parsed entity in which the markup |
| triggering the event appears. |
| <p>If the system identifier is a URL, the parser must resolve it |
| fully before passing it to the application. For example, a file |
| name must always be provided as a <em>file:...</em> URL, and other |
| kinds of relative URI are also resolved against their bases. |
| <p> |
| Returns a string containing the system identifier, or null |
| if none is available.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">string SystemId { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Sax_ILocator_SystemId_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.ILocator.html#Sax_ILocator_PublicId">PublicId</a></div> |
| </div> |
| <h3 id="seealso">See Also</h3> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.IContentHandler.html#Sax_IContentHandler_SetDocumentLocator_Sax_ILocator_">SetDocumentLocator</a>(<a class="xref" href="Sax.ILocator.html">ILocator</a>)</div> |
| </div> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Sax_ILocator.md&value=---%0Auid%3A%20Sax.ILocator%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/Support/Sax/Locator.cs/#L42" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |
