blob: 0b2265a4967eb2ec571507158800ebb5a58b83a2 [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:35 PDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MemoryIDMigrator (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="MemoryIDMigrator (Mahout Map-Reduce 0.13.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/MemoryIDMigrator.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/cf/taste/impl/model/GenericUserPreferenceArray.html" title="class in org.apache.mahout.cf.taste.impl.model"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/mahout/cf/taste/impl/model/MySQLJDBCIDMigrator.html" title="class in org.apache.mahout.cf.taste.impl.model"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/mahout/cf/taste/impl/model/MemoryIDMigrator.html" target="_top">Frames</a></li>
<li><a href="MemoryIDMigrator.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.cf.taste.impl.model</div>
<h2 title="Class MemoryIDMigrator" class="title">Class MemoryIDMigrator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/mahout/cf/taste/impl/model/AbstractIDMigrator.html" title="class in org.apache.mahout.cf.taste.impl.model">org.apache.mahout.cf.taste.impl.model.AbstractIDMigrator</a></li>
<li>
<ul class="inheritance">
<li>org.apache.mahout.cf.taste.impl.model.MemoryIDMigrator</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../org/apache/mahout/cf/taste/common/Refreshable.html" title="interface in org.apache.mahout.cf.taste.common">Refreshable</a>, <a href="../../../../../../../org/apache/mahout/cf/taste/model/IDMigrator.html" title="interface in org.apache.mahout.cf.taste.model">IDMigrator</a>, <a href="../../../../../../../org/apache/mahout/cf/taste/model/UpdatableIDMigrator.html" title="interface in org.apache.mahout.cf.taste.model">UpdatableIDMigrator</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">MemoryIDMigrator</span>
extends <a href="../../../../../../../org/apache/mahout/cf/taste/impl/model/AbstractIDMigrator.html" title="class in org.apache.mahout.cf.taste.impl.model">AbstractIDMigrator</a>
implements <a href="../../../../../../../org/apache/mahout/cf/taste/model/UpdatableIDMigrator.html" title="interface in org.apache.mahout.cf.taste.model">UpdatableIDMigrator</a></pre>
<div class="block">Implementation which stores the reverse long-to-String mapping in memory.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/model/MemoryIDMigrator.html#MemoryIDMigrator--">MemoryIDMigrator</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/cf/taste/impl/model/MemoryIDMigrator.html#initialize-java.lang.Iterable-">initialize</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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>&gt;&nbsp;stringIDs)</code>
<div class="block">Make the mapping aware of the given string IDs.</div>
</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/cf/taste/impl/model/MemoryIDMigrator.html#storeMapping-long-java.lang.String-">storeMapping</a></span>(long&nbsp;longID,
<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;stringID)</code>
<div class="block">Stores the reverse long-to-String mapping in some kind of backing store.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/mahout/cf/taste/impl/model/MemoryIDMigrator.html#toStringID-long-">toStringID</a></span>(long&nbsp;longID)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.mahout.cf.taste.impl.model.AbstractIDMigrator">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.mahout.cf.taste.impl.model.<a href="../../../../../../../org/apache/mahout/cf/taste/impl/model/AbstractIDMigrator.html" title="class in org.apache.mahout.cf.taste.impl.model">AbstractIDMigrator</a></h3>
<code><a href="../../../../../../../org/apache/mahout/cf/taste/impl/model/AbstractIDMigrator.html#hash-java.lang.String-">hash</a>, <a href="../../../../../../../org/apache/mahout/cf/taste/impl/model/AbstractIDMigrator.html#refresh-java.util.Collection-">refresh</a>, <a href="../../../../../../../org/apache/mahout/cf/taste/impl/model/AbstractIDMigrator.html#toLongID-java.lang.String-">toLongID</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.mahout.cf.taste.model.IDMigrator">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.mahout.cf.taste.model.<a href="../../../../../../../org/apache/mahout/cf/taste/model/IDMigrator.html" title="interface in org.apache.mahout.cf.taste.model">IDMigrator</a></h3>
<code><a href="../../../../../../../org/apache/mahout/cf/taste/model/IDMigrator.html#toLongID-java.lang.String-">toLongID</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.mahout.cf.taste.common.Refreshable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.mahout.cf.taste.common.<a href="../../../../../../../org/apache/mahout/cf/taste/common/Refreshable.html" title="interface in org.apache.mahout.cf.taste.common">Refreshable</a></h3>
<code><a href="../../../../../../../org/apache/mahout/cf/taste/common/Refreshable.html#refresh-java.util.Collection-">refresh</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="MemoryIDMigrator--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MemoryIDMigrator</h4>
<pre>public&nbsp;MemoryIDMigrator()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="storeMapping-long-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeMapping</h4>
<pre>public&nbsp;void&nbsp;storeMapping(long&nbsp;longID,
<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;stringID)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/mahout/cf/taste/model/UpdatableIDMigrator.html#storeMapping-long-java.lang.String-">UpdatableIDMigrator</a></code></span></div>
<div class="block">Stores the reverse long-to-String mapping in some kind of backing store. Note that this must be called
directly (or indirectly through <a href="../../../../../../../org/apache/mahout/cf/taste/model/UpdatableIDMigrator.html#initialize-java.lang.Iterable-"><code>UpdatableIDMigrator.initialize(Iterable)</code></a>) for every String that might be encountered
in the application, or else the mapping will not be known.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/mahout/cf/taste/model/UpdatableIDMigrator.html#storeMapping-long-java.lang.String-">storeMapping</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/mahout/cf/taste/model/UpdatableIDMigrator.html" title="interface in org.apache.mahout.cf.taste.model">UpdatableIDMigrator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>longID</code> - long ID</dd>
<dd><code>stringID</code> - string ID that maps to/from that long ID</dd>
</dl>
</li>
</ul>
<a name="toStringID-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toStringID</h4>
<pre>public&nbsp;<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;toStringID(long&nbsp;longID)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/mahout/cf/taste/model/IDMigrator.html#toStringID-long-">toStringID</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/mahout/cf/taste/model/IDMigrator.html" title="interface in org.apache.mahout.cf.taste.model">IDMigrator</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the string ID most recently associated with the given long ID, or null if doesn't exist</dd>
</dl>
</li>
</ul>
<a name="initialize-java.lang.Iterable-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>initialize</h4>
<pre>public&nbsp;void&nbsp;initialize(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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>&gt;&nbsp;stringIDs)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/mahout/cf/taste/model/UpdatableIDMigrator.html#initialize-java.lang.Iterable-">UpdatableIDMigrator</a></code></span></div>
<div class="block">Make the mapping aware of the given string IDs. This must be called initially before the implementation
is used, or else it will not be aware of reverse long-to-String mappings.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/mahout/cf/taste/model/UpdatableIDMigrator.html#initialize-java.lang.Iterable-">initialize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/mahout/cf/taste/model/UpdatableIDMigrator.html" title="interface in org.apache.mahout.cf.taste.model">UpdatableIDMigrator</a></code></dd>
</dl>
</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/MemoryIDMigrator.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/cf/taste/impl/model/GenericUserPreferenceArray.html" title="class in org.apache.mahout.cf.taste.impl.model"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/mahout/cf/taste/impl/model/MySQLJDBCIDMigrator.html" title="class in org.apache.mahout.cf.taste.impl.model"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/mahout/cf/taste/impl/model/MemoryIDMigrator.html" target="_top">Frames</a></li>
<li><a href="MemoryIDMigrator.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>