github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-03-26 11:01:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

documentation version 1.4.2

Browse Source
This commit is contained in:
Jeremy Long
2016-07-31 08:10:07 -04:00
parent 6193968089
commit 44917ad0d3
1319 changed files with 93942 additions and 60498 deletions
Download Patch File Download Diff File Expand all files Collapse all files

102
xref/org/owasp/dependencycheck/data/lucene/FieldAnalyzer.html
View File

@@ -37,55 +37,59 @@
<a class="jxr_linenumber" name="L29" href="#L29">29</a>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * A Lucene Analyzer that utilizes the WhitespaceTokenizer, WordDelimiterFilter, LowerCaseFilter, and StopFilter. The intended</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * purpose of this Analyzer is to index the CPE fields vendor and product.&lt;/p&gt;</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/FieldAnalyzer.html">FieldAnalyzer</a> <strong class="jxr_keyword">extends</strong> Analyzer {
<a class="jxr_linenumber" name="L38" href="#L38">38</a>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * The Lucene Version used.</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Version version;
<a class="jxr_linenumber" name="L43" href="#L43">43</a>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * Creates a new FieldAnalyzer.</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @param version the Lucene version</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/FieldAnalyzer.html">FieldAnalyzer</a>(Version version) {
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">this</strong>.version = version;
<a class="jxr_linenumber" name="L51" href="#L51">51</a> }
<a class="jxr_linenumber" name="L52" href="#L52">52</a>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * Creates the TokenStreamComponents</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * @param fieldName the field name being analyzed</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * @param reader the reader containing the input</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * @return the TokenStreamComponents</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> @Override
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">protected</strong> TokenStreamComponents createComponents(String fieldName, Reader reader) {
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">final</strong> Tokenizer source = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/AlphaNumericTokenizer.html">AlphaNumericTokenizer</a>(version, reader);
<a class="jxr_linenumber" name="L63" href="#L63">63</a>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> TokenStream stream = source;
<a class="jxr_linenumber" name="L65" href="#L65">65</a>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> stream = <strong class="jxr_keyword">new</strong> WordDelimiterFilter(stream,
<a class="jxr_linenumber" name="L67" href="#L67">67</a> WordDelimiterFilter.CATENATE_WORDS
<a class="jxr_linenumber" name="L68" href="#L68">68</a> | WordDelimiterFilter.GENERATE_WORD_PARTS
<a class="jxr_linenumber" name="L69" href="#L69">69</a> | WordDelimiterFilter.GENERATE_NUMBER_PARTS
<a class="jxr_linenumber" name="L70" href="#L70">70</a> | WordDelimiterFilter.PRESERVE_ORIGINAL
<a class="jxr_linenumber" name="L71" href="#L71">71</a> | WordDelimiterFilter.SPLIT_ON_CASE_CHANGE
<a class="jxr_linenumber" name="L72" href="#L72">72</a> | WordDelimiterFilter.SPLIT_ON_NUMERICS
<a class="jxr_linenumber" name="L73" href="#L73">73</a> | WordDelimiterFilter.STEM_ENGLISH_POSSESSIVE, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L74" href="#L74">74</a>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> stream = <strong class="jxr_keyword">new</strong> LowerCaseFilter(version, stream);
<a class="jxr_linenumber" name="L76" href="#L76">76</a> stream = <strong class="jxr_keyword">new</strong> StopFilter(version, stream, StopAnalyzer.ENGLISH_STOP_WORDS_SET);
<a class="jxr_linenumber" name="L77" href="#L77">77</a>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> TokenStreamComponents(source, stream);
<a class="jxr_linenumber" name="L79" href="#L79">79</a> }
<a class="jxr_linenumber" name="L80" href="#L80">80</a> }
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * A Lucene Analyzer that utilizes the WhitespaceTokenizer, WordDelimiterFilter,</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * LowerCaseFilter, and StopFilter. The intended purpose of this Analyzer is to</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * index the CPE fields vendor and product.&lt;/p&gt;</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * @deprecated the field analyzer should not be used, instead use the</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * SearchFieldAnalyzer so that the token analyzing filter is used.</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> @Deprecated
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/FieldAnalyzer.html">FieldAnalyzer</a> <strong class="jxr_keyword">extends</strong> Analyzer {
<a class="jxr_linenumber" name="L42" href="#L42">42</a>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * The Lucene Version used.</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Version version;
<a class="jxr_linenumber" name="L47" href="#L47">47</a>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * Creates a new FieldAnalyzer.</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @param version the Lucene version</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/FieldAnalyzer.html">FieldAnalyzer</a>(Version version) {
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">this</strong>.version = version;
<a class="jxr_linenumber" name="L55" href="#L55">55</a> }
<a class="jxr_linenumber" name="L56" href="#L56">56</a>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * Creates the TokenStreamComponents</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @param fieldName the field name being analyzed</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * @param reader the reader containing the input</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * @return the TokenStreamComponents</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> @Override
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">protected</strong> TokenStreamComponents createComponents(String fieldName, Reader reader) {
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">final</strong> Tokenizer source = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/AlphaNumericTokenizer.html">AlphaNumericTokenizer</a>(version, reader);
<a class="jxr_linenumber" name="L67" href="#L67">67</a>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> TokenStream stream = source;
<a class="jxr_linenumber" name="L69" href="#L69">69</a>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> stream = <strong class="jxr_keyword">new</strong> WordDelimiterFilter(stream,
<a class="jxr_linenumber" name="L71" href="#L71">71</a> WordDelimiterFilter.CATENATE_WORDS
<a class="jxr_linenumber" name="L72" href="#L72">72</a> | WordDelimiterFilter.GENERATE_WORD_PARTS
<a class="jxr_linenumber" name="L73" href="#L73">73</a> | WordDelimiterFilter.GENERATE_NUMBER_PARTS
<a class="jxr_linenumber" name="L74" href="#L74">74</a> | WordDelimiterFilter.PRESERVE_ORIGINAL
<a class="jxr_linenumber" name="L75" href="#L75">75</a> | WordDelimiterFilter.SPLIT_ON_CASE_CHANGE
<a class="jxr_linenumber" name="L76" href="#L76">76</a> | WordDelimiterFilter.SPLIT_ON_NUMERICS
<a class="jxr_linenumber" name="L77" href="#L77">77</a> | WordDelimiterFilter.STEM_ENGLISH_POSSESSIVE, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L78" href="#L78">78</a>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> stream = <strong class="jxr_keyword">new</strong> LowerCaseFilter(version, stream);
<a class="jxr_linenumber" name="L80" href="#L80">80</a> stream = <strong class="jxr_keyword">new</strong> StopFilter(version, stream, StopAnalyzer.ENGLISH_STOP_WORDS_SET);
<a class="jxr_linenumber" name="L81" href="#L81">81</a>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> TokenStreamComponents(source, stream);
<a class="jxr_linenumber" name="L83" href="#L83">83</a> }
<a class="jxr_linenumber" name="L84" href="#L84">84</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2012&#x2013;2016 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>