blob: c5543cab73bff5647049222aa0e879f212dc1de3 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class Attribute
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Attribute
| 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="core/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="Lucene.Net.Util.Attribute">
<h1 id="Lucene_Net_Util_Attribute" data-uid="Lucene.Net.Util.Attribute" class="text-break">Class Attribute
</h1>
<div class="markdown level0 summary"><p>Base class for Attributes that can be added to a
<a class="xref" href="Lucene.Net.Util.AttributeSource.html">AttributeSource</a>.
<p>
Attributes are used to add data in a dynamic, yet type-safe way to a source
of usually streamed objects, e. g. a <a class="xref" href="Lucene.Net.Analysis.TokenStream.html">TokenStream</a>.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">Attribute</span></div>
<div class="level2"><a class="xref" href="Lucene.Net.Analysis.NumericTokenStream.NumericTermAttribute.html">NumericTokenStream.NumericTermAttribute</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.CharTermAttribute.html">CharTermAttribute</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.FlagsAttribute.html">FlagsAttribute</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.KeywordAttribute.html">KeywordAttribute</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.OffsetAttribute.html">OffsetAttribute</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.PayloadAttribute.html">PayloadAttribute</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.PositionIncrementAttribute.html">PositionIncrementAttribute</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.PositionLengthAttribute.html">PositionLengthAttribute</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.TypeAttribute.html">TypeAttribute</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Search.BoostAttribute.html">BoostAttribute</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Search.FuzzyTermsEnum.LevenshteinAutomataAttribute.html">FuzzyTermsEnum.LevenshteinAutomataAttribute</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Search.MaxNonCompetitiveBoostAttribute.html">MaxNonCompetitiveBoostAttribute</a></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><a class="xref" href="Lucene.Net.Util.IAttribute.html">IAttribute</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Util.html">Lucene.Net.Util</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.dll</h6>
<h5 id="Lucene_Net_Util_Attribute_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class Attribute : IAttribute</code></pre>
</div>
<h3 id="methods">Methods
</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=Lucene_Net_Util_Attribute_Clear.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Attribute.Clear%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/Util/AttributeImpl.cs/#L40">View Source</a>
</span>
<a id="Lucene_Net_Util_Attribute_Clear_" data-uid="Lucene.Net.Util.Attribute.Clear*"></a>
<h4 id="Lucene_Net_Util_Attribute_Clear" data-uid="Lucene.Net.Util.Attribute.Clear">Clear()</h4>
<div class="markdown level1 summary"><p>Clears the values in this <a class="xref" href="Lucene.Net.Util.Attribute.html">Attribute</a> and resets it to its
default value. If this implementation implements more than one <a class="xref" href="Lucene.Net.Util.Attribute.html">Attribute</a> interface
it clears all.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract void Clear()</code></pre>
</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=Lucene_Net_Util_Attribute_Clone.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Attribute.Clone%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/Util/AttributeImpl.cs/#L198">View Source</a>
</span>
<a id="Lucene_Net_Util_Attribute_Clone_" data-uid="Lucene.Net.Util.Attribute.Clone*"></a>
<h4 id="Lucene_Net_Util_Attribute_Clone" data-uid="Lucene.Net.Util.Attribute.Clone">Clone()</h4>
<div class="markdown level1 summary"><p>Shallow clone. Subclasses must override this if they
need to clone any members deeply,</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual object Clone()</code></pre>
</div>
<h5 class="returns">Returns</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.Object</span></td>
<td></td>
</tr>
</tbody>
</table>
<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=Lucene_Net_Util_Attribute_CopyTo_Lucene_Net_Util_IAttribute_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Attribute.CopyTo(Lucene.Net.Util.IAttribute)%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/Util/AttributeImpl.cs/#L193">View Source</a>
</span>
<a id="Lucene_Net_Util_Attribute_CopyTo_" data-uid="Lucene.Net.Util.Attribute.CopyTo*"></a>
<h4 id="Lucene_Net_Util_Attribute_CopyTo_Lucene_Net_Util_IAttribute_" data-uid="Lucene.Net.Util.Attribute.CopyTo(Lucene.Net.Util.IAttribute)">CopyTo(IAttribute)</h4>
<div class="markdown level1 summary"><p>Copies the values from this <a class="xref" href="Lucene.Net.Util.Attribute.html">Attribute</a> into the passed-in
<code data-dev-comment-type="paramref" class="paramref">target</code> attribute. The <code data-dev-comment-type="paramref" class="paramref">target</code> implementation must support all the
<a class="xref" href="Lucene.Net.Util.IAttribute.html">IAttribute</a>s this implementation supports.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract void CopyTo(IAttribute target)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Util.IAttribute.html">IAttribute</a></td>
<td><span class="parametername">target</span></td>
<td></td>
</tr>
</tbody>
</table>
<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=Lucene_Net_Util_Attribute_ReflectAsString_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Attribute.ReflectAsString(System.Boolean)%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/Util/AttributeImpl.cs/#L85">View Source</a>
</span>
<a id="Lucene_Net_Util_Attribute_ReflectAsString_" data-uid="Lucene.Net.Util.Attribute.ReflectAsString*"></a>
<h4 id="Lucene_Net_Util_Attribute_ReflectAsString_System_Boolean_" data-uid="Lucene.Net.Util.Attribute.ReflectAsString(System.Boolean)">ReflectAsString(Boolean)</h4>
<div class="markdown level1 summary"><p>This method returns the current attribute values as a string in the following format
by calling the <a class="xref" href="Lucene.Net.Util.Attribute.html#Lucene_Net_Util_Attribute_ReflectWith_Lucene_Net_Util_IAttributeReflector_">ReflectWith(IAttributeReflector)</a> method:
<ul><li>if <code data-dev-comment-type="paramref" class="paramref">prependAttClass</code>=true: <code>&quot;AttributeClass.Key=value,AttributeClass.Key=value&quot;</code> </li><li>if <code data-dev-comment-type="paramref" class="paramref">prependAttClass</code>=false: <code>&quot;key=value,key=value&quot;</code> </li></ul></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ReflectAsString(bool prependAttClass)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">prependAttClass</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</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="Lucene_Net_Util_Attribute_ReflectAsString_System_Boolean__seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Util.Attribute.html#Lucene_Net_Util_Attribute_ReflectWith_Lucene_Net_Util_IAttributeReflector_">ReflectWith(IAttributeReflector)</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=Lucene_Net_Util_Attribute_ReflectWith_Lucene_Net_Util_IAttributeReflector_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Attribute.ReflectWith(Lucene.Net.Util.IAttributeReflector)%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/Util/AttributeImpl.cs/#L118">View Source</a>
</span>
<a id="Lucene_Net_Util_Attribute_ReflectWith_" data-uid="Lucene.Net.Util.Attribute.ReflectWith*"></a>
<h4 id="Lucene_Net_Util_Attribute_ReflectWith_Lucene_Net_Util_IAttributeReflector_" data-uid="Lucene.Net.Util.Attribute.ReflectWith(Lucene.Net.Util.IAttributeReflector)">ReflectWith(IAttributeReflector)</h4>
<div class="markdown level1 summary"><p>This method is for introspection of attributes, it should simply
add the key/values this attribute holds to the given <a class="xref" href="Lucene.Net.Util.IAttributeReflector.html">IAttributeReflector</a>.</p>
<p><p>The default implementation calls <a class="xref" href="Lucene.Net.Util.IAttributeReflector.html#Lucene_Net_Util_IAttributeReflector_Reflect_System_Type_System_String_System_Object_">Reflect(Type, String, Object)</a> for all
non-static fields from the implementing class, using the field name as key
and the field value as value. The <a class="xref" href="Lucene.Net.Util.IAttribute.html">IAttribute</a> class is also determined by Reflection.
Please note that the default implementation can only handle single-Attribute
implementations.</p>
<p><p>Custom implementations look like this (e.g. for a combined attribute implementation):</p>
<pre><code> public void ReflectWith(IAttributeReflector reflector)
{
reflector.Reflect(typeof(ICharTermAttribute), &quot;term&quot;, GetTerm());
reflector.Reflect(typeof(IPositionIncrementAttribute), &quot;positionIncrement&quot;, GetPositionIncrement());
}</code></pre>
<p><p>If you implement this method, make sure that for each invocation, the same set of <a class="xref" href="Lucene.Net.Util.IAttribute.html">IAttribute</a>
interfaces and keys are passed to <a class="xref" href="Lucene.Net.Util.IAttributeReflector.html#Lucene_Net_Util_IAttributeReflector_Reflect_System_Type_System_String_System_Object_">Reflect(Type, String, Object)</a> in the same order, but possibly
different values. So don&apos;t automatically exclude e.g. <code>null</code> properties!</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void ReflectWith(IAttributeReflector reflector)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Util.IAttributeReflector.html">IAttributeReflector</a></td>
<td><span class="parametername">reflector</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_Util_Attribute_ReflectWith_Lucene_Net_Util_IAttributeReflector__seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Util.Attribute.html#Lucene_Net_Util_Attribute_ReflectAsString_System_Boolean_">ReflectAsString(Boolean)</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=Lucene_Net_Util_Attribute_ToString.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Attribute.ToString%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/Util/AttributeImpl.cs/#L160">View Source</a>
</span>
<a id="Lucene_Net_Util_Attribute_ToString_" data-uid="Lucene.Net.Util.Attribute.ToString*"></a>
<h4 id="Lucene_Net_Util_Attribute_ToString" data-uid="Lucene.Net.Util.Attribute.ToString">ToString()</h4>
<div class="markdown level1 summary"><p>The default implementation of this method accesses all declared
fields of this object and prints the values in the following syntax:</p>
<pre><code>public String ToString()
{
return &quot;start=&quot; + startOffset + &quot;,end=&quot; + endOffset;
}</code></pre>
<p>This method may be overridden by subclasses.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
</div>
<h5 class="returns">Returns</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 class="overrides">Overrides</h5>
<div><span class="xref">System.Object.ToString()</span></div>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="Lucene.Net.Util.IAttribute.html">IAttribute</a>
</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=Lucene_Net_Util_Attribute.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Attribute%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/Util/AttributeImpl.cs/#L31" 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>