blob: 257c8974e798af576472cc480b073918b2d2e9b7 [file] [log] [blame]
<!DOCTYPE html >
<html>
<head>
<title>LEvents - PredictionIO Scala API 0.14.0 - org.apache.predictionio.data.storage.LEvents</title>
<meta name="description" content="LEvents - PredictionIO Scala API 0.14.0 - org.apache.predictionio.data.storage.LEvents" />
<meta name="keywords" content="LEvents PredictionIO Scala API 0.14.0 org.apache.predictionio.data.storage.LEvents" />
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<link href="../../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet" />
<link href="../../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css" />
<script type="text/javascript" src="../../../../../lib/jquery.js" id="jquery-js"></script>
<script type="text/javascript" src="../../../../../lib/jquery-ui.js"></script>
<script type="text/javascript" src="../../../../../lib/template.js"></script>
<script type="text/javascript" src="../../../../../lib/tools.tooltip.js"></script>
<script type="text/javascript">
if(top === self) {
var url = '../../../../../index.html';
var hash = 'org.apache.predictionio.data.storage.LEvents';
var anchor = window.location.hash;
var anchor_opt = '';
if (anchor.length >= 1)
anchor_opt = '@' + anchor.substring(1);
window.location.href = url + '#' + hash + anchor_opt;
}
</script>
</head>
<body class="type">
<div id="definition">
<img alt="Trait" src="../../../../../lib/trait_big.png" />
<p id="owner"><a href="../../../../package.html" class="extype" name="org">org</a>.<a href="../../../package.html" class="extype" name="org.apache">apache</a>.<a href="../../package.html" class="extype" name="org.apache.predictionio">predictionio</a>.<a href="../package.html" class="extype" name="org.apache.predictionio.data">data</a>.<a href="package.html" class="extype" name="org.apache.predictionio.data.storage">storage</a></p>
<h1>LEvents</h1><h3><span class="morelinks"><div>Related Doc:
<a href="package.html" class="extype" name="org.apache.predictionio.data.storage">package storage</a>
</div></span></h3><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</div>
<h4 id="signature" class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">trait</span>
</span>
<span class="symbol">
<span class="name">LEvents</span><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span>
</span>
</h4>
<div id="comment" class="fullcommenttop"><div class="comment cmt"><p>:: DeveloperApi ::
Base trait of a data access object that directly returns <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> without
going through Spark's parallelization. Engine developers should use
<a href="../store/LEventStore$.html" class="extype" name="org.apache.predictionio.data.store.LEventStore">org.apache.predictionio.data.store.LEventStore</a> instead of using this directly.
</p></div><dl class="attributes block"> <dt>Annotations</dt><dd>
<span class="name">@DeveloperApi</span><span class="args">()</span>
</dd></dl><div class="toggleContainer block">
<span class="toggle">Linear Supertypes</span>
<div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div>
</div></div>
<div id="mbrsel">
<div id="textfilter"><span class="pre"></span><span class="input"><input id="mbrsel-input" type="text" accesskey="/" /></span><span class="post"></span></div>
<div id="order">
<span class="filtertype">Ordering</span>
<ol>
<li class="alpha in"><span>Alphabetic</span></li>
<li class="inherit out"><span>By Inheritance</span></li>
</ol>
</div>
<div id="ancestors">
<span class="filtertype">Inherited<br />
</span>
<ol id="linearization">
<li class="in" name="org.apache.predictionio.data.storage.LEvents"><span>LEvents</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li>
</ol>
</div><div id="ancestors">
<span class="filtertype"></span>
<ol>
<li class="hideall out"><span>Hide All</span></li>
<li class="showall in"><span>Show All</span></li>
</ol>
</div>
<div id="visbl">
<span class="filtertype">Visibility</span>
<ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol>
</div>
</div>
<div id="template">
<div id="allMembers">
<div id="values" class="values members">
<h3>Abstract Value Members</h3>
<ol><li name="org.apache.predictionio.data.storage.LEvents#close" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped">
<a id="close():Unit"></a>
<a id="close():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">abstract </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">close</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@close():Unit" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">:: DeveloperApi ::
Close this Event Store interface object, e.g.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
Close this Event Store interface object, e.g. close connection, release
resources, etc.
</p></div><dl class="attributes block"> <dt>Annotations</dt><dd>
<span class="name">@DeveloperApi</span><span class="args">()</span>
</dd></dl></div>
</li><li name="org.apache.predictionio.data.storage.LEvents#futureDelete" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped">
<a id="futureDelete(eventId:String,appId:Int,channelId:Option[Int])(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[Boolean]"></a>
<a id="futureDelete(String,Int,Option[Int])(ExecutionContext):Future[Boolean]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">abstract </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">futureDelete</span><span class="params">(<span name="eventId">eventId: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="appId">appId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>, <span name="channelId">channelId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a>]</span>)</span><span class="params">(<span class="implicit">implicit </span><span name="ec">ec: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.ExecutionContext" class="extype" target="_top">ExecutionContext</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.Future" class="extype" target="_top">Future</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a>]</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@futureDelete(eventId:String,appId:Int,channelId:Option[Int])(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[Boolean]" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">:: DeveloperApi ::
Delete an <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> in a non-blocking fashion.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
Delete an <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> in a non-blocking fashion.
</p></div><dl class="paramcmts block"><dt class="param">eventId</dt><dd class="cmt"><p>ID of the <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a></p></dd><dt class="param">appId</dt><dd class="cmt"><p>ID of the app that contains the <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a></p></dd><dt class="param">channelId</dt><dd class="cmt"><p>Optional channel ID that contains the <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a></p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
<span class="name">@DeveloperApi</span><span class="args">()</span>
</dd></dl></div>
</li><li name="org.apache.predictionio.data.storage.LEvents#futureFind" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped">
<a id="futureFind(appId:Int,channelId:Option[Int],startTime:Option[org.joda.time.DateTime],untilTime:Option[org.joda.time.DateTime],entityType:Option[String],entityId:Option[String],eventNames:Option[Seq[String]],targetEntityType:Option[Option[String]],targetEntityId:Option[Option[String]],limit:Option[Int],reversed:Option[Boolean])(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[Iterator[org.apache.predictionio.data.storage.Event]]"></a>
<a id="futureFind(Int,Option[Int],Option[DateTime],Option[DateTime],Option[String],Option[String],Option[Seq[String]],Option[Option[String]],Option[Option[String]],Option[Int],Option[Boolean])(ExecutionContext):Future[Iterator[Event]]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">abstract </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">futureFind</span><span class="params">(<span name="appId">appId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>, <span name="channelId">channelId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a>] = <span class="symbol">None</span></span>, <span name="startTime">startTime: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<span class="extype" name="org.joda.time.DateTime">DateTime</span>] = <span class="symbol">None</span></span>, <span name="untilTime">untilTime: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<span class="extype" name="org.joda.time.DateTime">DateTime</span>] = <span class="symbol">None</span></span>, <span name="entityType">entityType: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<span class="extype" name="scala.Predef.String">String</span>] = <span class="symbol">None</span></span>, <span name="entityId">entityId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<span class="extype" name="scala.Predef.String">String</span>] = <span class="symbol">None</span></span>, <span name="eventNames">eventNames: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<span class="extype" name="scala.Seq">Seq</span>[<span class="extype" name="scala.Predef.String">String</span>]] = <span class="symbol">None</span></span>, <span name="targetEntityType">targetEntityType: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<span class="extype" name="scala.Predef.String">String</span>]] = <span class="symbol">None</span></span>, <span name="targetEntityId">targetEntityId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<span class="extype" name="scala.Predef.String">String</span>]] = <span class="symbol">None</span></span>, <span name="limit">limit: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a>] = <span class="symbol">None</span></span>, <span name="reversed">reversed: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a>] = <span class="symbol">None</span></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="ec">ec: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.ExecutionContext" class="extype" target="_top">ExecutionContext</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.Future" class="extype" target="_top">Future</a>[<span class="extype" name="scala.Iterator">Iterator</span>[<a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a>]]</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@futureFind(appId:Int,channelId:Option[Int],startTime:Option[org.joda.time.DateTime],untilTime:Option[org.joda.time.DateTime],entityType:Option[String],entityId:Option[String],eventNames:Option[Seq[String]],targetEntityType:Option[Option[String]],targetEntityId:Option[Option[String]],limit:Option[Int],reversed:Option[Boolean])(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[Iterator[org.apache.predictionio.data.storage.Event]]" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">:: DeveloperApi ::
Reads from database and returns a Future of Iterator of <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a>s.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
Reads from database and returns a Future of Iterator of <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a>s.
</p></div><dl class="paramcmts block"><dt class="param">appId</dt><dd class="cmt"><p>return events of this app ID</p></dd><dt class="param">channelId</dt><dd class="cmt"><p>return events of this channel ID (default channel if it's None)</p></dd><dt class="param">startTime</dt><dd class="cmt"><p>return events with eventTime &gt;= startTime</p></dd><dt class="param">untilTime</dt><dd class="cmt"><p>return events with eventTime &lt; untilTime</p></dd><dt class="param">entityType</dt><dd class="cmt"><p>return events of this entityType</p></dd><dt class="param">entityId</dt><dd class="cmt"><p>return events of this entityId</p></dd><dt class="param">eventNames</dt><dd class="cmt"><p>return events with any of these event names.</p></dd><dt class="param">targetEntityType</dt><dd class="cmt"><p>return events of this targetEntityType:</p><ul><li>None means no restriction on targetEntityType</li><li>Some(None) means no targetEntityType for this event</li><li>Some(Some(x)) means targetEntityType should match x.</li></ul></dd><dt class="param">targetEntityId</dt><dd class="cmt"><p>return events of this targetEntityId</p><ul><li>None means no restriction on targetEntityId</li><li>Some(None) means no targetEntityId for this event</li><li>Some(Some(x)) means targetEntityId should match x.</li></ul></dd><dt class="param">limit</dt><dd class="cmt"><p>Limit number of events. Get all events if None or Some(-1)</p></dd><dt class="param">reversed</dt><dd class="cmt"><p>Reverse the order.</p><ul><li>return oldest events first if None or Some(false) (default)</li><li>return latest events first if Some(true)</li></ul></dd><dt class="param">ec</dt><dd class="cmt"><p>ExecutionContext</p></dd><dt>returns</dt><dd class="cmt"><p>Future[Iterator[Event]]</p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
<span class="name">@DeveloperApi</span><span class="args">()</span>
</dd></dl></div>
</li><li name="org.apache.predictionio.data.storage.LEvents#futureGet" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped">
<a id="futureGet(eventId:String,appId:Int,channelId:Option[Int])(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[Option[org.apache.predictionio.data.storage.Event]]"></a>
<a id="futureGet(String,Int,Option[Int])(ExecutionContext):Future[Option[Event]]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">abstract </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">futureGet</span><span class="params">(<span name="eventId">eventId: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="appId">appId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>, <span name="channelId">channelId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a>]</span>)</span><span class="params">(<span class="implicit">implicit </span><span name="ec">ec: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.ExecutionContext" class="extype" target="_top">ExecutionContext</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.Future" class="extype" target="_top">Future</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a>]]</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@futureGet(eventId:String,appId:Int,channelId:Option[Int])(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[Option[org.apache.predictionio.data.storage.Event]]" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">:: DeveloperApi ::
Get an <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> in a non-blocking fashion.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
Get an <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> in a non-blocking fashion.
</p></div><dl class="paramcmts block"><dt class="param">eventId</dt><dd class="cmt"><p>ID of the <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a></p></dd><dt class="param">appId</dt><dd class="cmt"><p>ID of the app that contains the <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a></p></dd><dt class="param">channelId</dt><dd class="cmt"><p>Optional channel ID that contains the <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a></p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
<span class="name">@DeveloperApi</span><span class="args">()</span>
</dd></dl></div>
</li><li name="org.apache.predictionio.data.storage.LEvents#futureInsert" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped">
<a id="futureInsert(event:org.apache.predictionio.data.storage.Event,appId:Int,channelId:Option[Int])(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[String]"></a>
<a id="futureInsert(Event,Int,Option[Int])(ExecutionContext):Future[String]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">abstract </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">futureInsert</span><span class="params">(<span name="event">event: <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a></span>, <span name="appId">appId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>, <span name="channelId">channelId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a>]</span>)</span><span class="params">(<span class="implicit">implicit </span><span name="ec">ec: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.ExecutionContext" class="extype" target="_top">ExecutionContext</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.Future" class="extype" target="_top">Future</a>[<span class="extype" name="scala.Predef.String">String</span>]</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@futureInsert(event:org.apache.predictionio.data.storage.Event,appId:Int,channelId:Option[Int])(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[String]" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">:: DeveloperApi ::
Insert an <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> in a non-blocking fashion.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
Insert an <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> in a non-blocking fashion.
</p></div><dl class="paramcmts block"><dt class="param">event</dt><dd class="cmt"><p>An <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> to be inserted</p></dd><dt class="param">appId</dt><dd class="cmt"><p>App ID for the <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> to be inserted to</p></dd><dt class="param">channelId</dt><dd class="cmt"><p>Optional channel ID for the <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> to be inserted to</p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
<span class="name">@DeveloperApi</span><span class="args">()</span>
</dd></dl></div>
</li><li name="org.apache.predictionio.data.storage.LEvents#init" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped">
<a id="init(appId:Int,channelId:Option[Int]):Boolean"></a>
<a id="init(Int,Option[Int]):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">abstract </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">init</span><span class="params">(<span name="appId">appId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>, <span name="channelId">channelId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a>] = <span class="symbol">None</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@init(appId:Int,channelId:Option[Int]):Boolean" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">:: DeveloperApi ::
Initialize Event Store for an app ID and optionally a channel ID.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
Initialize Event Store for an app ID and optionally a channel ID.
This routine is to be called when an app is first created.
</p></div><dl class="paramcmts block"><dt class="param">appId</dt><dd class="cmt"><p>App ID</p></dd><dt class="param">channelId</dt><dd class="cmt"><p>Optional channel ID</p></dd><dt>returns</dt><dd class="cmt"><p>true if initialization was successful; false otherwise.</p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
<span class="name">@DeveloperApi</span><span class="args">()</span>
</dd></dl></div>
</li><li name="org.apache.predictionio.data.storage.LEvents#remove" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped">
<a id="remove(appId:Int,channelId:Option[Int]):Boolean"></a>
<a id="remove(Int,Option[Int]):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">abstract </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">remove</span><span class="params">(<span name="appId">appId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>, <span name="channelId">channelId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a>] = <span class="symbol">None</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@remove(appId:Int,channelId:Option[Int]):Boolean" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">:: DeveloperApi ::
Remove Event Store for an app ID and optional channel ID.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
Remove Event Store for an app ID and optional channel ID.
</p></div><dl class="paramcmts block"><dt class="param">appId</dt><dd class="cmt"><p>App ID</p></dd><dt class="param">channelId</dt><dd class="cmt"><p>Optional channel ID</p></dd><dt>returns</dt><dd class="cmt"><p>true if removal was successful; false otherwise.</p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
<span class="name">@DeveloperApi</span><span class="args">()</span>
</dd></dl></div>
</li></ol>
</div>
<div id="values" class="values members">
<h3>Concrete Value Members</h3>
<ol><li name="scala.AnyRef#!=" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="!=(x$1:Any):Boolean"></a>
<a id="!=(Any):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span title="gt4s: $bang$eq" class="name">!=</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@!=(x$1:Any):Boolean" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef###" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="##():Int"></a>
<a id="##():Int"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span title="gt4s: $hash$hash" class="name">##</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@##():Int" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#==" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="==(x$1:Any):Boolean"></a>
<a id="==(Any):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span title="gt4s: $eq$eq" class="name">==</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@==(x$1:Any):Boolean" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.Any#asInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="asInstanceOf[T0]:T0"></a>
<a id="asInstanceOf[T0]:T0"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Any.asInstanceOf.T0">T0</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@asInstanceOf[T0]:T0" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
</li><li name="scala.AnyRef#clone" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="clone():Object"></a>
<a id="clone():AnyRef"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">clone</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.AnyRef">AnyRef</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@clone():Object" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.CloneNotSupportedException]">...</span>
</span>)</span>
</dd></dl></div>
</li><li name="org.apache.predictionio.data.storage.LEvents#defaultTimeout" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="defaultTimeout:scala.concurrent.duration.FiniteDuration"></a>
<a id="defaultTimeout:FiniteDuration"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">val</span>
</span>
<span class="symbol">
<span class="name">defaultTimeout</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.duration.FiniteDuration" class="extype" target="_top">FiniteDuration</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@defaultTimeout:scala.concurrent.duration.FiniteDuration" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Default timeout for asynchronous operations that is set to 1 minute</p>
</li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="eq(x$1:AnyRef):Boolean"></a>
<a id="eq(AnyRef):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@eq(x$1:AnyRef):Boolean" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#equals" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="equals(x$1:Any):Boolean"></a>
<a id="equals(Any):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@equals(x$1:Any):Boolean" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#finalize" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="finalize():Unit"></a>
<a id="finalize():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">finalize</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@finalize():Unit" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="symbol">classOf[java.lang.Throwable]</span>
</span>)</span>
</dd></dl></div>
</li><li name="org.apache.predictionio.data.storage.LEvents#futureDelete" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="futureDelete(eventId:String,appId:Int)(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[Boolean]"></a>
<a id="futureDelete(String,Int)(ExecutionContext):Future[Boolean]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">futureDelete</span><span class="params">(<span name="eventId">eventId: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="appId">appId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="ec">ec: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.ExecutionContext" class="extype" target="_top">ExecutionContext</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.Future" class="extype" target="_top">Future</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a>]</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@futureDelete(eventId:String,appId:Int)(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[Boolean]" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">:: DeveloperApi ::
Delete an <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> in a non-blocking fashion.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
Delete an <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> in a non-blocking fashion.
</p></div><dl class="paramcmts block"><dt class="param">eventId</dt><dd class="cmt"><p>ID of the <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a></p></dd><dt class="param">appId</dt><dd class="cmt"><p>ID of the app that contains the <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a></p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
<span class="name">@DeveloperApi</span><span class="args">()</span>
</dd></dl></div>
</li><li name="org.apache.predictionio.data.storage.LEvents#futureGet" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="futureGet(eventId:String,appId:Int)(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[Option[org.apache.predictionio.data.storage.Event]]"></a>
<a id="futureGet(String,Int)(ExecutionContext):Future[Option[Event]]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">futureGet</span><span class="params">(<span name="eventId">eventId: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="appId">appId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="ec">ec: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.ExecutionContext" class="extype" target="_top">ExecutionContext</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.Future" class="extype" target="_top">Future</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a>]]</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@futureGet(eventId:String,appId:Int)(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[Option[org.apache.predictionio.data.storage.Event]]" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">:: DeveloperApi ::
Get an <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> in a non-blocking fashion.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
Get an <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> in a non-blocking fashion.
</p></div><dl class="paramcmts block"><dt class="param">eventId</dt><dd class="cmt"><p>ID of the <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a></p></dd><dt class="param">appId</dt><dd class="cmt"><p>ID of the app that contains the <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a></p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
<span class="name">@DeveloperApi</span><span class="args">()</span>
</dd></dl></div>
</li><li name="org.apache.predictionio.data.storage.LEvents#futureInsert" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="futureInsert(event:org.apache.predictionio.data.storage.Event,appId:Int)(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[String]"></a>
<a id="futureInsert(Event,Int)(ExecutionContext):Future[String]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">futureInsert</span><span class="params">(<span name="event">event: <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a></span>, <span name="appId">appId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="ec">ec: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.ExecutionContext" class="extype" target="_top">ExecutionContext</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.Future" class="extype" target="_top">Future</a>[<span class="extype" name="scala.Predef.String">String</span>]</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@futureInsert(event:org.apache.predictionio.data.storage.Event,appId:Int)(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[String]" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">:: DeveloperApi ::
Insert an <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> in a non-blocking fashion.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
Insert an <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> in a non-blocking fashion.
</p></div><dl class="paramcmts block"><dt class="param">event</dt><dd class="cmt"><p>An <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> to be inserted</p></dd><dt class="param">appId</dt><dd class="cmt"><p>App ID for the <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> to be inserted to</p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
<span class="name">@DeveloperApi</span><span class="args">()</span>
</dd></dl></div>
</li><li name="org.apache.predictionio.data.storage.LEvents#futureInsertBatch" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="futureInsertBatch(events:Seq[org.apache.predictionio.data.storage.Event],appId:Int,channelId:Option[Int])(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[Seq[String]]"></a>
<a id="futureInsertBatch(Seq[Event],Int,Option[Int])(ExecutionContext):Future[Seq[String]]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">futureInsertBatch</span><span class="params">(<span name="events">events: <span class="extype" name="scala.Seq">Seq</span>[<a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a>]</span>, <span name="appId">appId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>, <span name="channelId">channelId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a>]</span>)</span><span class="params">(<span class="implicit">implicit </span><span name="ec">ec: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.ExecutionContext" class="extype" target="_top">ExecutionContext</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.Future" class="extype" target="_top">Future</a>[<span class="extype" name="scala.Seq">Seq</span>[<span class="extype" name="scala.Predef.String">String</span>]]</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@futureInsertBatch(events:Seq[org.apache.predictionio.data.storage.Event],appId:Int,channelId:Option[Int])(implicitec:scala.concurrent.ExecutionContext):scala.concurrent.Future[Seq[String]]" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">:: DeveloperApi ::
Insert <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a>s in a non-blocking fashion.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
Insert <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a>s in a non-blocking fashion.</p><p>Default implementation of this method is calling
<span class="extype" name="LEvents.futureInsert(Event,">Int, Option[Int])</span> per event.
Override in the storage implementation if the storage has
a better way to insert multiple data at once.
</p></div><dl class="paramcmts block"><dt class="param">events</dt><dd class="cmt"><p><a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a>s to be inserted</p></dd><dt class="param">appId</dt><dd class="cmt"><p>App ID for the <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a>s to be inserted to</p></dd><dt class="param">channelId</dt><dd class="cmt"><p>Optional channel ID for the <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a>s to be inserted to</p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
<span class="name">@DeveloperApi</span><span class="args">()</span>
</dd></dl></div>
</li><li name="scala.AnyRef#getClass" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="getClass():Class[_]"></a>
<a id="getClass():Class[_]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">getClass</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Class">Class</span>[_]</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@getClass():Class[_]" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#hashCode" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="hashCode():Int"></a>
<a id="hashCode():Int"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">hashCode</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@hashCode():Int" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.Any#isInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="isInstanceOf[T0]:Boolean"></a>
<a id="isInstanceOf[T0]:Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">isInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@isInstanceOf[T0]:Boolean" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
</li><li name="scala.AnyRef#ne" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="ne(x$1:AnyRef):Boolean"></a>
<a id="ne(AnyRef):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">ne</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@ne(x$1:AnyRef):Boolean" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#notify" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="notify():Unit"></a>
<a id="notify():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">notify</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@notify():Unit" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#notifyAll" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="notifyAll():Unit"></a>
<a id="notifyAll():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">notifyAll</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@notifyAll():Unit" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="synchronized[T0](x$1:=&gt;T0):T0"></a>
<a id="synchronized[T0](⇒T0):T0"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: ⇒ <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>)</span><span class="result">: <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@synchronized[T0](x$1:=&gt;T0):T0" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#toString" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="toString():String"></a>
<a id="toString():String"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@toString():String" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="wait():Unit"></a>
<a id="wait():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">wait</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@wait():Unit" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
</span>)</span>
</dd></dl></div>
</li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="wait(x$1:Long,x$2:Int):Unit"></a>
<a id="wait(Long,Int):Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">wait</span><span class="params">(<span name="arg0">arg0: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Long" class="extype" target="_top">Long</a></span>, <span name="arg1">arg1: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@wait(x$1:Long,x$2:Int):Unit" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
</span>)</span>
</dd></dl></div>
</li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="wait(x$1:Long):Unit"></a>
<a id="wait(Long):Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">wait</span><span class="params">(<span name="arg0">arg0: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Long" class="extype" target="_top">Long</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@wait(x$1:Long):Unit" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
</span>)</span>
</dd></dl></div>
</li></ol>
</div>
<div id="values" class="values members">
<h3>Deprecated Value Members</h3>
<ol><li name="org.apache.predictionio.data.storage.LEvents#findSingleEntity" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="findSingleEntity(appId:Int,channelId:Option[Int],entityType:String,entityId:String,eventNames:Option[Seq[String]],targetEntityType:Option[Option[String]],targetEntityId:Option[Option[String]],startTime:Option[org.joda.time.DateTime],untilTime:Option[org.joda.time.DateTime],limit:Option[Int],latest:Boolean,timeout:scala.concurrent.duration.Duration)(implicitec:scala.concurrent.ExecutionContext):Either[org.apache.predictionio.data.storage.StorageError,Iterator[org.apache.predictionio.data.storage.Event]]"></a>
<a id="findSingleEntity(Int,Option[Int],String,String,Option[Seq[String]],Option[Option[String]],Option[Option[String]],Option[DateTime],Option[DateTime],Option[Int],Boolean,Duration)(ExecutionContext):Either[StorageError,Iterator[Event]]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name deprecated" title="Deprecated: (Since version 0.9.2) Use LEventStore.findByEntity() instead.">findSingleEntity</span><span class="params">(<span name="appId">appId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>, <span name="channelId">channelId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a>] = <span class="symbol">None</span></span>, <span name="entityType">entityType: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="entityId">entityId: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="eventNames">eventNames: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<span class="extype" name="scala.Seq">Seq</span>[<span class="extype" name="scala.Predef.String">String</span>]] = <span class="symbol">None</span></span>, <span name="targetEntityType">targetEntityType: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<span class="extype" name="scala.Predef.String">String</span>]] = <span class="symbol">None</span></span>, <span name="targetEntityId">targetEntityId: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<span class="extype" name="scala.Predef.String">String</span>]] = <span class="symbol">None</span></span>, <span name="startTime">startTime: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<span class="extype" name="org.joda.time.DateTime">DateTime</span>] = <span class="symbol">None</span></span>, <span name="untilTime">untilTime: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<span class="extype" name="org.joda.time.DateTime">DateTime</span>] = <span class="symbol">None</span></span>, <span name="limit">limit: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a>] = <span class="symbol">None</span></span>, <span name="latest">latest: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a> = <span class="symbol">true</span></span>, <span name="timeout">timeout: <span class="extype" name="scala.concurrent.duration.Duration">Duration</span> = <span class="symbol"><span class="name"><a href="#defaultTimeout:scala.concurrent.duration.FiniteDuration">defaultTimeout</a></span></span></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="ec">ec: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.concurrent.ExecutionContext" class="extype" target="_top">ExecutionContext</a></span>)</span><span class="result">: <span class="extype" name="scala.Either">Either</span>[<span class="extype" name="org.apache.predictionio.data.storage.StorageError">StorageError</span>, <span class="extype" name="scala.Iterator">Iterator</span>[<a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a>]]</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.data.storage.LEvents@findSingleEntity(appId:Int,channelId:Option[Int],entityType:String,entityId:String,eventNames:Option[Seq[String]],targetEntityType:Option[Option[String]],targetEntityId:Option[Option[String]],startTime:Option[org.joda.time.DateTime],untilTime:Option[org.joda.time.DateTime],limit:Option[Int],latest:Boolean,timeout:scala.concurrent.duration.Duration)(implicitec:scala.concurrent.ExecutionContext):Either[org.apache.predictionio.data.storage.StorageError,Iterator[org.apache.predictionio.data.storage.Event]]" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">reads events of the specified entity.</p><div class="fullcomment"><div class="comment cmt"><p>reads events of the specified entity.
</p></div><dl class="paramcmts block"><dt class="param">appId</dt><dd class="cmt"><p>return events of this app ID</p></dd><dt class="param">channelId</dt><dd class="cmt"><p>return events of this channel ID (default channel if it's None)</p></dd><dt class="param">entityType</dt><dd class="cmt"><p>return events of this entityType</p></dd><dt class="param">entityId</dt><dd class="cmt"><p>return events of this entityId</p></dd><dt class="param">eventNames</dt><dd class="cmt"><p>return events with any of these event names.</p></dd><dt class="param">targetEntityType</dt><dd class="cmt"><p>return events of this targetEntityType:</p><ul><li>None means no restriction on targetEntityType</li><li>Some(None) means no targetEntityType for this event</li><li>Some(Some(x)) means targetEntityType should match x.</li></ul></dd><dt class="param">targetEntityId</dt><dd class="cmt"><p>return events of this targetEntityId</p><ul><li>None means no restriction on targetEntityId</li><li>Some(None) means no targetEntityId for this event</li><li>Some(Some(x)) means targetEntityId should match x.</li></ul></dd><dt class="param">startTime</dt><dd class="cmt"><p>return events with eventTime &gt;= startTime</p></dd><dt class="param">untilTime</dt><dd class="cmt"><p>return events with eventTime &lt; untilTime</p></dd><dt class="param">limit</dt><dd class="cmt"><p>Limit number of events. Get all events if None or Some(-1)</p></dd><dt class="param">latest</dt><dd class="cmt"><p>Return latest event first (default true)</p></dd><dt class="param">ec</dt><dd class="cmt"><p>ExecutionContext</p></dd><dt>returns</dt><dd class="cmt"><p>Either[StorageError, Iterator[Event]]</p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
<span class="name">@deprecated</span>
</dd><dt>Deprecated</dt><dd class="cmt"><p><i>(Since version 0.9.2)</i> Use LEventStore.findByEntity() instead.</p></dd></dl></div>
</li></ol>
</div>
</div>
<div id="inheritedMembers">
<div class="parent" name="scala.AnyRef">
<h3>Inherited from <span class="extype" name="scala.AnyRef">AnyRef</span></h3>
</div><div class="parent" name="scala.Any">
<h3>Inherited from <span class="extype" name="scala.Any">Any</span></h3>
</div>
</div>
<div id="groupedMembers">
<div class="group" name="Ungrouped">
<h3>Ungrouped</h3>
</div>
</div>
</div>
<div id="tooltip"></div>
<div id="footer"> </div>
</body>
</html>