Google Git
Sign in
apache / mahout / master / . / docs / 0.13.0 / api / docs / mahout-mr / org / apache / mahout / common / parameters / Parametered.html
blob: 836600e335c95fa1ef6dfee06c57eb33fef92244 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_121) on Fri Apr 14 22:11:36 PDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Parametered (Mahout Map-Reduce 0.13.0 API)</title>
<meta name="date" content="2017-04-14">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Parametered (Mahout Map-Reduce 0.13.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Parametered.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/mahout/common/parameters/Parameter.html" title="interface in org.apache.mahout.common.parameters"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/mahout/common/parameters/Parametered.ParameteredGeneralizations.html" title="class in org.apache.mahout.common.parameters"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mahout/common/parameters/Parametered.html" target="_top">Frames</a></li>
<li><a href="Parametered.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.mahout.common.parameters</div>
<h2 title="Interface Parametered" class="title">Interface Parametered</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/apache/mahout/clustering/Cluster.html" title="interface in org.apache.mahout.clustering">Cluster</a>, <a href="../../../../../org/apache/mahout/common/distance/DistanceMeasure.html" title="interface in org.apache.mahout.common.distance">DistanceMeasure</a>, <a href="../../../../../org/apache/mahout/common/parameters/Parameter.html" title="interface in org.apache.mahout.common.parameters">Parameter</a>&lt;T&gt;</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/mahout/clustering/AbstractCluster.html" title="class in org.apache.mahout.clustering">AbstractCluster</a>, <a href="../../../../../org/apache/mahout/common/parameters/AbstractParameter.html" title="class in org.apache.mahout.common.parameters">AbstractParameter</a>, <a href="../../../../../org/apache/mahout/clustering/canopy/Canopy.html" title="class in org.apache.mahout.clustering.canopy">Canopy</a>, <a href="../../../../../org/apache/mahout/common/distance/ChebyshevDistanceMeasure.html" title="class in org.apache.mahout.common.distance">ChebyshevDistanceMeasure</a>, <a href="../../../../../org/apache/mahout/common/parameters/ClassParameter.html" title="class in org.apache.mahout.common.parameters">ClassParameter</a>, <a href="../../../../../org/apache/mahout/common/distance/CosineDistanceMeasure.html" title="class in org.apache.mahout.common.distance">CosineDistanceMeasure</a>, <a href="../../../../../org/apache/mahout/clustering/iterator/DistanceMeasureCluster.html" title="class in org.apache.mahout.clustering.iterator">DistanceMeasureCluster</a>, <a href="../../../../../org/apache/mahout/common/parameters/DoubleParameter.html" title="class in org.apache.mahout.common.parameters">DoubleParameter</a>, <a href="../../../../../org/apache/mahout/common/distance/EuclideanDistanceMeasure.html" title="class in org.apache.mahout.common.distance">EuclideanDistanceMeasure</a>, <a href="../../../../../org/apache/mahout/clustering/kmeans/Kluster.html" title="class in org.apache.mahout.clustering.kmeans">Kluster</a>, <a href="../../../../../org/apache/mahout/common/distance/MahalanobisDistanceMeasure.html" title="class in org.apache.mahout.common.distance">MahalanobisDistanceMeasure</a>, <a href="../../../../../org/apache/mahout/common/distance/ManhattanDistanceMeasure.html" title="class in org.apache.mahout.common.distance">ManhattanDistanceMeasure</a>, <a href="../../../../../org/apache/mahout/common/distance/MinkowskiDistanceMeasure.html" title="class in org.apache.mahout.common.distance">MinkowskiDistanceMeasure</a>, <a href="../../../../../org/apache/mahout/common/parameters/PathParameter.html" title="class in org.apache.mahout.common.parameters">PathParameter</a>, <a href="../../../../../org/apache/mahout/clustering/fuzzykmeans/SoftCluster.html" title="class in org.apache.mahout.clustering.fuzzykmeans">SoftCluster</a>, <a href="../../../../../org/apache/mahout/common/distance/SquaredEuclideanDistanceMeasure.html" title="class in org.apache.mahout.common.distance">SquaredEuclideanDistanceMeasure</a>, <a href="../../../../../org/apache/mahout/common/distance/TanimotoDistanceMeasure.html" title="class in org.apache.mahout.common.distance">TanimotoDistanceMeasure</a>, <a href="../../../../../org/apache/mahout/common/distance/WeightedDistanceMeasure.html" title="class in org.apache.mahout.common.distance">WeightedDistanceMeasure</a>, <a href="../../../../../org/apache/mahout/common/distance/WeightedEuclideanDistanceMeasure.html" title="class in org.apache.mahout.common.distance">WeightedEuclideanDistanceMeasure</a>, <a href="../../../../../org/apache/mahout/common/distance/WeightedManhattanDistanceMeasure.html" title="class in org.apache.mahout.common.distance">WeightedManhattanDistanceMeasure</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Parametered</span></pre>
<div class="block">Meta information and accessors for configuring a job.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/common/parameters/Parametered.ParameteredGeneralizations.html" title="class in org.apache.mahout.common.parameters">Parametered.ParameteredGeneralizations</a></span></code>
<div class="block">"multiple inheritance"</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static org.slf4j.Logger</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/common/parameters/Parametered.html#log">log</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/common/parameters/Parametered.html#configure-org.apache.hadoop.conf.Configuration-">configure</a></span>(org.apache.hadoop.conf.Configuration&nbsp;config)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/common/parameters/Parametered.html#createParameters-java.lang.String-org.apache.hadoop.conf.Configuration-">createParameters</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;prefix,
org.apache.hadoop.conf.Configuration&nbsp;jobConf)</code>
<div class="block">EXPERT: consumers should never have to call this method.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../org/apache/mahout/common/parameters/Parameter.html" title="interface in org.apache.mahout.common.parameters">Parameter</a>&lt;?&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/common/parameters/Parametered.html#getParameters--">getParameters</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="log">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>log</h4>
<pre>static final&nbsp;org.slf4j.Logger log</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getParameters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameters</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../org/apache/mahout/common/parameters/Parameter.html" title="interface in org.apache.mahout.common.parameters">Parameter</a>&lt;?&gt;&gt;&nbsp;getParameters()</pre>
</li>
</ul>
<a name="createParameters-java.lang.String-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createParameters</h4>
<pre>void&nbsp;createParameters(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;prefix,
org.apache.hadoop.conf.Configuration&nbsp;jobConf)</pre>
<div class="block">EXPERT: consumers should never have to call this method. It would be friendly visible to
<a href="../../../../../org/apache/mahout/common/parameters/Parametered.ParameteredGeneralizations.html" title="class in org.apache.mahout.common.parameters"><code>Parametered.ParameteredGeneralizations</code></a> if java supported it. Calling this method should create a new list of
parameters and is called</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>prefix</code> - ends with a dot if not empty.</dd>
<dd><code>jobConf</code> - configuration used for retrieving values</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/mahout/common/parameters/Parametered.ParameteredGeneralizations.html#configureParameters-java.lang.String-org.apache.mahout.common.parameters.Parametered-org.apache.hadoop.conf.Configuration-"><code>invoking method</code></a>,
<a href="../../../../../org/apache/mahout/common/parameters/Parametered.ParameteredGeneralizations.html#configureParametersRecursively-org.apache.mahout.common.parameters.Parametered-java.lang.String-org.apache.hadoop.conf.Configuration-"><code>invoking method</code></a></dd>
</dl>
</li>
</ul>
<a name="configure-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>configure</h4>
<pre>void&nbsp;configure(org.apache.hadoop.conf.Configuration&nbsp;config)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Parametered.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/mahout/common/parameters/Parameter.html" title="interface in org.apache.mahout.common.parameters"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/mahout/common/parameters/Parametered.ParameteredGeneralizations.html" title="class in org.apache.mahout.common.parameters"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mahout/common/parameters/Parametered.html" target="_top">Frames</a></li>
<li><a href="Parametered.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>