da599c3a78
* Fix broken API doc links Create symlink for latest to point to v0.7. Group APIs by top version number rather than individual * Update swift and android version numbers to match Mentats * Update documentation * Update top level .gitignore to ignore docs site & metatdata * Add README to help with building documentation site * Address review comments @ncalexan
254 lines
19 KiB
HTML
254 lines
19 KiB
HTML
<!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_152-release) on Thu Jun 28 11:01:15 BST 2018 -->
|
|
<title>R-Index</title>
|
|
<meta name="date" content="2018-06-28">
|
|
<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="R-Index";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
</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="../org/mozilla/mentat/package-summary.html">Package</a></li>
|
|
<li>Class</li>
|
|
<li><a href="../overview-tree.html">Tree</a></li>
|
|
<li><a href="../deprecated-list.html">Deprecated</a></li>
|
|
<li class="navBarCell1Rev">Index</li>
|
|
<li><a href="../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="index-14.html">Prev Letter</a></li>
|
|
<li><a href="index-16.html">Next Letter</a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../index.html?index-files/index-15.html" target="_top">Frames</a></li>
|
|
<li><a href="index-15.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../allclasses-noframe.html">All 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>
|
|
<a name="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<div class="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">O</a> <a href="index-14.html">Q</a> <a href="index-15.html">R</a> <a href="index-16.html">S</a> <a href="index-17.html">T</a> <a href="index-18.html">U</a> <a href="index-19.html">V</a> <a name="I:R">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">R</h2>
|
|
<dl>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/Mentat.html#registerObserver-java.lang.String-java.lang.String:A-org.mozilla.mentat.TxObserverCallback-">registerObserver(String, String[], TxObserverCallback)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/Mentat.html" title="class in org.mozilla.mentat">Mentat</a></dt>
|
|
<dd>
|
|
<div class="block">Register an callback and a set of attributes to observer for transaction observation.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/JNA.RelResult.html#RelResult--">RelResult()</a></span> - Constructor for class org.mozilla.mentat.<a href="../org/mozilla/mentat/JNA.RelResult.html" title="class in org.mozilla.mentat">JNA.RelResult</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../org/mozilla/mentat/RelResult.html" title="class in org.mozilla.mentat"><span class="typeNameLink">RelResult</span></a> - Class in <a href="../org/mozilla/mentat/package-summary.html">org.mozilla.mentat</a></dt>
|
|
<dd>
|
|
<div class="block">Wraps a `Rel` result from a Mentat query.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/RelResult.html#RelResult-org.mozilla.mentat.JNA.RelResult-">RelResult(JNA.RelResult)</a></span> - Constructor for class org.mozilla.mentat.<a href="../org/mozilla/mentat/RelResult.html" title="class in org.mozilla.mentat">RelResult</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../org/mozilla/mentat/RelResultHandler.html" title="interface in org.mozilla.mentat"><span class="typeNameLink">RelResultHandler</span></a> - Interface in <a href="../org/mozilla/mentat/package-summary.html">org.mozilla.mentat</a></dt>
|
|
<dd>
|
|
<div class="block">Interface defining the structure of a callback from a query returning a <a href="../org/mozilla/mentat/RelResult.html" title="class in org.mozilla.mentat"><code>RelResult</code></a>.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/JNA.RelResultIter.html#RelResultIter--">RelResultIter()</a></span> - Constructor for class org.mozilla.mentat.<a href="../org/mozilla/mentat/JNA.RelResultIter.html" title="class in org.mozilla.mentat">JNA.RelResultIter</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../org/mozilla/mentat/RelResultIterator.html" title="class in org.mozilla.mentat"><span class="typeNameLink">RelResultIterator</span></a> - Class in <a href="../org/mozilla/mentat/package-summary.html">org.mozilla.mentat</a></dt>
|
|
<dd>
|
|
<div class="block">Iterator for a <a href="../org/mozilla/mentat/RelResult.html" title="class in org.mozilla.mentat"><code>RelResult</code></a></div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/TxChangeList.html#reports">reports</a></span> - Variable in class org.mozilla.mentat.<a href="../org/mozilla/mentat/TxChangeList.html" title="class in org.mozilla.mentat">TxChangeList</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/EntityBuilder.html#retract-java.lang.String-long-">retract(String, long)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/EntityBuilder.html" title="class in org.mozilla.mentat">EntityBuilder</a></dt>
|
|
<dd>
|
|
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/EntityBuilder.html#retract-java.lang.String-boolean-">retract(String, boolean)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/EntityBuilder.html" title="class in org.mozilla.mentat">EntityBuilder</a></dt>
|
|
<dd>
|
|
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/EntityBuilder.html#retract-java.lang.String-double-">retract(String, double)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/EntityBuilder.html" title="class in org.mozilla.mentat">EntityBuilder</a></dt>
|
|
<dd>
|
|
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/EntityBuilder.html#retract-java.lang.String-java.util.Date-">retract(String, Date)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/EntityBuilder.html" title="class in org.mozilla.mentat">EntityBuilder</a></dt>
|
|
<dd>
|
|
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/EntityBuilder.html#retract-java.lang.String-java.lang.String-">retract(String, String)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/EntityBuilder.html" title="class in org.mozilla.mentat">EntityBuilder</a></dt>
|
|
<dd>
|
|
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/EntityBuilder.html#retract-java.lang.String-java.util.UUID-">retract(String, UUID)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/EntityBuilder.html" title="class in org.mozilla.mentat">EntityBuilder</a></dt>
|
|
<dd>
|
|
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/InProgressBuilder.html#retract-long-java.lang.String-long-">retract(long, String, long)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/InProgressBuilder.html" title="class in org.mozilla.mentat">InProgressBuilder</a></dt>
|
|
<dd>
|
|
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/InProgressBuilder.html#retract-long-java.lang.String-boolean-">retract(long, String, boolean)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/InProgressBuilder.html" title="class in org.mozilla.mentat">InProgressBuilder</a></dt>
|
|
<dd>
|
|
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/InProgressBuilder.html#retract-long-java.lang.String-double-">retract(long, String, double)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/InProgressBuilder.html" title="class in org.mozilla.mentat">InProgressBuilder</a></dt>
|
|
<dd>
|
|
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/InProgressBuilder.html#retract-long-java.lang.String-java.util.Date-">retract(long, String, Date)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/InProgressBuilder.html" title="class in org.mozilla.mentat">InProgressBuilder</a></dt>
|
|
<dd>
|
|
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/InProgressBuilder.html#retract-long-java.lang.String-java.lang.String-">retract(long, String, String)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/InProgressBuilder.html" title="class in org.mozilla.mentat">InProgressBuilder</a></dt>
|
|
<dd>
|
|
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/InProgressBuilder.html#retract-long-java.lang.String-java.util.UUID-">retract(long, String, UUID)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/InProgressBuilder.html" title="class in org.mozilla.mentat">InProgressBuilder</a></dt>
|
|
<dd>
|
|
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/EntityBuilder.html#retractKeyword-java.lang.String-java.lang.String-">retractKeyword(String, String)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/EntityBuilder.html" title="class in org.mozilla.mentat">EntityBuilder</a></dt>
|
|
<dd>
|
|
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/InProgressBuilder.html#retractKeyword-long-java.lang.String-java.lang.String-">retractKeyword(long, String, String)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/InProgressBuilder.html" title="class in org.mozilla.mentat">InProgressBuilder</a></dt>
|
|
<dd>
|
|
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/EntityBuilder.html#retractRef-java.lang.String-long-">retractRef(String, long)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/EntityBuilder.html" title="class in org.mozilla.mentat">EntityBuilder</a></dt>
|
|
<dd>
|
|
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/InProgressBuilder.html#retractRef-long-java.lang.String-long-">retractRef(long, String, long)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/InProgressBuilder.html" title="class in org.mozilla.mentat">InProgressBuilder</a></dt>
|
|
<dd>
|
|
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/InProgress.html#rollback--">rollback()</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/InProgress.html" title="class in org.mozilla.mentat">InProgress</a></dt>
|
|
<dd>
|
|
<div class="block">Rolls back all the transacts that have been performed on this `InProgress`, either directly
|
|
or through a Builder.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/JNA.html#row_at_index-org.mozilla.mentat.JNA.RelResult-int-">row_at_index(JNA.RelResult, int)</a></span> - Method in interface org.mozilla.mentat.<a href="../org/mozilla/mentat/JNA.html" title="interface in org.mozilla.mentat">JNA</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/RelResult.html#rowAtIndex-int-">rowAtIndex(int)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/RelResult.html" title="class in org.mozilla.mentat">RelResult</a></dt>
|
|
<dd>
|
|
<div class="block">Fetch the row at the requested index.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/Query.html#run-org.mozilla.mentat.RelResultHandler-">run(RelResultHandler)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/Query.html" title="class in org.mozilla.mentat">Query</a></dt>
|
|
<dd>
|
|
<div class="block">Execute the query with the values bound associated with this <a href="../org/mozilla/mentat/Query.html" title="class in org.mozilla.mentat"><code>Query</code></a> and call the provided
|
|
callback function with the results as a list of rows of <a href="../org/mozilla/mentat/TypedValue.html" title="class in org.mozilla.mentat"><code>TypedValue</code></a>s.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/Query.html#run-org.mozilla.mentat.ScalarResultHandler-">run(ScalarResultHandler)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/Query.html" title="class in org.mozilla.mentat">Query</a></dt>
|
|
<dd>
|
|
<div class="block">Execute the query with the values bound associated with this <a href="../org/mozilla/mentat/Query.html" title="class in org.mozilla.mentat"><code>Query</code></a> and call the provided
|
|
callback function with the results with the result as a single <a href="../org/mozilla/mentat/TypedValue.html" title="class in org.mozilla.mentat"><code>TypedValue</code></a>.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/Query.html#run-org.mozilla.mentat.CollResultHandler-">run(CollResultHandler)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/Query.html" title="class in org.mozilla.mentat">Query</a></dt>
|
|
<dd>
|
|
<div class="block">Execute the query with the values bound associated with this <a href="../org/mozilla/mentat/Query.html" title="class in org.mozilla.mentat"><code>Query</code></a> and call the provided
|
|
callback function with the results with the result as a list of single <a href="../org/mozilla/mentat/TypedValue.html" title="class in org.mozilla.mentat"><code>TypedValue</code></a>s.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/Query.html#run-org.mozilla.mentat.TupleResultHandler-">run(TupleResultHandler)</a></span> - Method in class org.mozilla.mentat.<a href="../org/mozilla/mentat/Query.html" title="class in org.mozilla.mentat">Query</a></dt>
|
|
<dd>
|
|
<div class="block">Execute the query with the values bound associated with this <a href="../org/mozilla/mentat/Query.html" title="class in org.mozilla.mentat"><code>Query</code></a> and call the provided
|
|
callback function with the results with the result as a list of single <a href="../org/mozilla/mentat/TypedValue.html" title="class in org.mozilla.mentat"><code>TypedValue</code></a>s.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/JNA.html#rust_c_string_destroy-com.sun.jna.Pointer-">rust_c_string_destroy(Pointer)</a></span> - Method in interface org.mozilla.mentat.<a href="../org/mozilla/mentat/JNA.html" title="interface in org.mozilla.mentat">JNA</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../org/mozilla/mentat/RustError.html" title="class in org.mozilla.mentat"><span class="typeNameLink">RustError</span></a> - Class in <a href="../org/mozilla/mentat/package-summary.html">org.mozilla.mentat</a></dt>
|
|
<dd>
|
|
<div class="block">Represents a C struct containing a <code>Pointer</code>s and String that map to a Rust Result.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="../org/mozilla/mentat/RustError.html#RustError--">RustError()</a></span> - Constructor for class org.mozilla.mentat.<a href="../org/mozilla/mentat/RustError.html" title="class in org.mozilla.mentat">RustError</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../org/mozilla/mentat/RustError.ByReference.html" title="class in org.mozilla.mentat"><span class="typeNameLink">RustError.ByReference</span></a> - Class in <a href="../org/mozilla/mentat/package-summary.html">org.mozilla.mentat</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="../org/mozilla/mentat/RustError.ByValue.html" title="class in org.mozilla.mentat"><span class="typeNameLink">RustError.ByValue</span></a> - Class in <a href="../org/mozilla/mentat/package-summary.html">org.mozilla.mentat</a></dt>
|
|
<dd> </dd>
|
|
</dl>
|
|
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">O</a> <a href="index-14.html">Q</a> <a href="index-15.html">R</a> <a href="index-16.html">S</a> <a href="index-17.html">T</a> <a href="index-18.html">U</a> <a href="index-19.html">V</a> </div>
|
|
<!-- ======= 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="../org/mozilla/mentat/package-summary.html">Package</a></li>
|
|
<li>Class</li>
|
|
<li><a href="../overview-tree.html">Tree</a></li>
|
|
<li><a href="../deprecated-list.html">Deprecated</a></li>
|
|
<li class="navBarCell1Rev">Index</li>
|
|
<li><a href="../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="index-14.html">Prev Letter</a></li>
|
|
<li><a href="index-16.html">Next Letter</a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../index.html?index-files/index-15.html" target="_top">Frames</a></li>
|
|
<li><a href="index-15.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../allclasses-noframe.html">All 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>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|