| <!DOCTYPE html > |
| <html> |
| <head> |
| <title>storage - PredictionIO Scala API 0.14.0 - org.apache.predictionio.data.storage</title> |
| <meta name="description" content="storage - PredictionIO Scala API 0.14.0 - org.apache.predictionio.data.storage" /> |
| <meta name="keywords" content="storage PredictionIO Scala API 0.14.0 org.apache.predictionio.data.storage" /> |
| <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.package'; |
| 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="value"> |
| <div id="definition"> |
| <img alt="Package" src="../../../../../lib/package_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></p> |
| <h1>storage</h1><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package" 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">package</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">storage</span> |
| </span> |
| </h4> |
| |
| <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>If you are an engine developer, please refer to the <a href="../store/package.html" class="extype" name="org.apache.predictionio.data.store">store</a> package.</p><p>This package provides convenient access to underlying data access objects. |
| The common entry point is <a href="Storage$.html" class="extype" name="org.apache.predictionio.data.storage.Storage">Storage</a>.</p><p>Developer APIs are available to advanced developers to add support of other |
| data store backends. |
| </p></div><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="group out"><span>Grouped</span></li> |
| <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"><span>storage</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="types" class="types members"> |
| <h3>Type Members</h3> |
| <ol><li name="org.apache.predictionio.data.storage.AccessKey" visbl="pub" data-isabs="false" fullComment="yes" group="Meta Data"> |
| <a id="AccessKeyextendsProductwithSerializable"></a> |
| <a id="AccessKey:AccessKey"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="AccessKey.html"><span class="name">AccessKey</span></a><span class="params">(<span name="key">key: <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="events">events: <span class="extype" name="scala.Seq">Seq</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>)</span><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Product" class="extype" target="_top">Product</a> with <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@AccessKeyextendsProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Stores mapping of access keys, app IDs, and lists of allowed event names |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Stores mapping of access keys, app IDs, and lists of allowed event names |
| </p></div><dl class="paramcmts block"><dt class="param">key</dt><dd class="cmt"><p>Access key</p></dd><dt class="param">appid</dt><dd class="cmt"><p>App ID</p></dd><dt class="param">events</dt><dd class="cmt"><p>List of allowed events for this particular app key</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.AccessKeys" visbl="pub" data-isabs="true" fullComment="yes" group="Meta Data"> |
| <a id="AccessKeysextendsAnyRef"></a> |
| <a id="AccessKeys:AccessKeys"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="AccessKeys.html"><span class="name">AccessKeys</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@AccessKeysextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Base trait of the <a href="AccessKey.html" class="extype" name="org.apache.predictionio.data.storage.AccessKey">AccessKey</a> data access object |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Base trait of the <a href="AccessKey.html" class="extype" name="org.apache.predictionio.data.storage.AccessKey">AccessKey</a> data access object |
| </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.App" visbl="pub" data-isabs="false" fullComment="yes" group="Meta Data"> |
| <a id="AppextendsProductwithSerializable"></a> |
| <a id="App:App"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="App.html"><span class="name">App</span></a><span class="params">(<span name="id">id: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>, <span name="name">name: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="description">description: <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>)</span><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Product" class="extype" target="_top">Product</a> with <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@AppextendsProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Stores mapping of app IDs and names |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Stores mapping of app IDs and names |
| </p></div><dl class="paramcmts block"><dt class="param">id</dt><dd class="cmt"><p>ID of the app.</p></dd><dt class="param">name</dt><dd class="cmt"><p>Name of the app.</p></dd><dt class="param">description</dt><dd class="cmt"><p>Long description of the app.</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.Apps" visbl="pub" data-isabs="true" fullComment="yes" group="Meta Data"> |
| <a id="AppsextendsAnyRef"></a> |
| <a id="Apps:Apps"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="Apps.html"><span class="name">Apps</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@AppsextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Base trait of the <a href="App.html" class="extype" name="org.apache.predictionio.data.storage.App">App</a> data access object |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Base trait of the <a href="App.html" class="extype" name="org.apache.predictionio.data.storage.App">App</a> data access object |
| </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.BaseStorageClient" visbl="pub" data-isabs="true" fullComment="yes" group="Storage System"> |
| <a id="BaseStorageClientextendsAnyRef"></a> |
| <a id="BaseStorageClient:BaseStorageClient"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="BaseStorageClient.html"><span class="name">BaseStorageClient</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@BaseStorageClientextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Any storage backend drivers will need to implement this trait with exactly |
| <b>StorageClient</b> as the class name.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Any storage backend drivers will need to implement this trait with exactly |
| <b>StorageClient</b> as the class name. PredictionIO storage layer will look |
| for this class when it instantiates the actual backend for use by higher |
| level storage access APIs. |
| </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.BiMap" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="BiMap[K,V]extendsSerializable"></a> |
| <a id="BiMap[K,V]:BiMap[K,V]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="BiMap.html"><span class="name">BiMap</span></a><span class="tparams">[<span name="K">K</span>, <span name="V">V</span>]</span><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@BiMap[K,V]extendsSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Immutable Bi-directional Map</p> |
| </li><li name="org.apache.predictionio.data.storage.Channel" visbl="pub" data-isabs="false" fullComment="yes" group="Meta Data"> |
| <a id="ChannelextendsProductwithSerializable"></a> |
| <a id="Channel:Channel"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Channel.html"><span class="name">Channel</span></a><span class="params">(<span name="id">id: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>, <span name="name">name: <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="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Product" class="extype" target="_top">Product</a> with <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@ChannelextendsProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Stores mapping of channel IDs, names and app ID |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Stores mapping of channel IDs, names and app ID |
| </p></div><dl class="paramcmts block"><dt class="param">id</dt><dd class="cmt"><p>ID of the channel</p></dd><dt class="param">name</dt><dd class="cmt"><p>Name of the channel (must be unique within the same app)</p></dd><dt class="param">appid</dt><dd class="cmt"><p>ID of the app which this channel belongs 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.Channels" visbl="pub" data-isabs="true" fullComment="yes" group="Meta Data"> |
| <a id="ChannelsextendsAnyRef"></a> |
| <a id="Channels:Channels"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="Channels.html"><span class="name">Channels</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@ChannelsextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Base trait of the <a href="Channel.html" class="extype" name="org.apache.predictionio.data.storage.Channel">Channel</a> data access object |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Base trait of the <a href="Channel.html" class="extype" name="org.apache.predictionio.data.storage.Channel">Channel</a> data access object |
| </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.DataMap" visbl="pub" data-isabs="false" fullComment="yes" group="Event Data"> |
| <a id="DataMapextendsSerializable"></a> |
| <a id="DataMap:DataMap"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="DataMap.html"><span class="name">DataMap</span></a><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@DataMapextendsSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">A DataMap stores properties of the event or entity.</p><div class="fullcomment"><div class="comment cmt"><p>A DataMap stores properties of the event or entity. Internally it is a Map |
| whose keys are property names and values are corresponding JSON values |
| respectively. Use the <span class="extype" name="get[T](name:">String,clazz: Class[T])</span> method to |
| retrieve the value of a mandatory property or use <a href="DataMap.html#getOpt[T](name:String)(implicitevidence$2:Manifest[T]):Option[T]" class="extmbr" name="org.apache.predictionio.data.storage.DataMap#getOpt">getOpt</a> to retrieve the |
| value of an optional property. |
| </p></div></div> |
| </li><li name="org.apache.predictionio.data.storage.DataMapException" visbl="pub" data-isabs="false" fullComment="no" group="Event Data"> |
| <a id="DataMapExceptionextendsExceptionwithProductwithSerializable"></a> |
| <a id="DataMapException:DataMapException"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="DataMapException.html"><span class="name">DataMapException</span></a><span class="params">(<span name="msg">msg: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="cause">cause: <span class="extype" name="scala.Exception">Exception</span></span>)</span><span class="result"> extends <span class="extype" name="scala.Exception">Exception</span> with <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Product" class="extype" target="_top">Product</a> with <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@DataMapExceptionextendsExceptionwithProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Exception class for <a href="DataMap.html" class="extype" name="org.apache.predictionio.data.storage.DataMap">DataMap</a> |
| </p> |
| </li><li name="org.apache.predictionio.data.storage.EngineInstance" visbl="pub" data-isabs="false" fullComment="yes" group="Meta Data"> |
| <a id="EngineInstanceextendsProductwithSerializable"></a> |
| <a id="EngineInstance:EngineInstance"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="EngineInstance.html"><span class="name">EngineInstance</span></a><span class="params">(<span name="id">id: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="status">status: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="startTime">startTime: <span class="extype" name="com.github.nscala_time.time.TypeImports.DateTime">com.github.nscala_time.time.Imports.DateTime</span></span>, <span name="endTime">endTime: <span class="extype" name="com.github.nscala_time.time.TypeImports.DateTime">com.github.nscala_time.time.Imports.DateTime</span></span>, <span name="engineId">engineId: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="engineVersion">engineVersion: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="engineVariant">engineVariant: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="engineFactory">engineFactory: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="batch">batch: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="env">env: <span class="extype" name="scala.Predef.Map">Map</span>[<span class="extype" name="scala.Predef.String">String</span>, <span class="extype" name="scala.Predef.String">String</span>]</span>, <span name="sparkConf">sparkConf: <span class="extype" name="scala.Predef.Map">Map</span>[<span class="extype" name="scala.Predef.String">String</span>, <span class="extype" name="scala.Predef.String">String</span>]</span>, <span name="dataSourceParams">dataSourceParams: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="preparatorParams">preparatorParams: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="algorithmsParams">algorithmsParams: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="servingParams">servingParams: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Product" class="extype" target="_top">Product</a> with <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@EngineInstanceextendsProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Stores parameters, model, and other information for each engine instance |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Stores parameters, model, and other information for each engine instance |
| </p></div><dl class="paramcmts block"><dt class="param">id</dt><dd class="cmt"><p>Engine instance ID.</p></dd><dt class="param">status</dt><dd class="cmt"><p>Status of the engine instance.</p></dd><dt class="param">startTime</dt><dd class="cmt"><p>Start time of the training/evaluation.</p></dd><dt class="param">endTime</dt><dd class="cmt"><p>End time of the training/evaluation.</p></dd><dt class="param">engineId</dt><dd class="cmt"><p>Engine ID of the instance.</p></dd><dt class="param">engineVersion</dt><dd class="cmt"><p>Engine version of the instance.</p></dd><dt class="param">engineVariant</dt><dd class="cmt"><p>Engine variant ID of the instance.</p></dd><dt class="param">engineFactory</dt><dd class="cmt"><p>Engine factory class for the instance.</p></dd><dt class="param">batch</dt><dd class="cmt"><p>A batch label of the engine instance.</p></dd><dt class="param">env</dt><dd class="cmt"><p>The environment in which the instance was created.</p></dd><dt class="param">sparkConf</dt><dd class="cmt"><p>Custom Spark configuration of the instance.</p></dd><dt class="param">dataSourceParams</dt><dd class="cmt"><p>Data source parameters of the instance.</p></dd><dt class="param">preparatorParams</dt><dd class="cmt"><p>Preparator parameters of the instance.</p></dd><dt class="param">algorithmsParams</dt><dd class="cmt"><p>Algorithms parameters of the instance.</p></dd><dt class="param">servingParams</dt><dd class="cmt"><p>Serving parameters of the instance.</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.EngineInstanceSerializer" visbl="pub" data-isabs="false" fullComment="yes" group="Meta Data"> |
| <a id="EngineInstanceSerializerextendsCustomSerializer[org.apache.predictionio.data.storage.EngineInstance]"></a> |
| <a id="EngineInstanceSerializer:EngineInstanceSerializer"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="EngineInstanceSerializer.html"><span class="name">EngineInstanceSerializer</span></a><span class="result"> extends <span class="extype" name="org.json4s.CustomSerializer">CustomSerializer</span>[<a href="EngineInstance.html" class="extype" name="org.apache.predictionio.data.storage.EngineInstance">EngineInstance</a>]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@EngineInstanceSerializerextendsCustomSerializer[org.apache.predictionio.data.storage.EngineInstance]" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| JSON4S serializer for <a href="EngineInstance.html" class="extype" name="org.apache.predictionio.data.storage.EngineInstance">EngineInstance</a> |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| JSON4S serializer for <a href="EngineInstance.html" class="extype" name="org.apache.predictionio.data.storage.EngineInstance">EngineInstance</a> |
| </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.EngineInstances" visbl="pub" data-isabs="true" fullComment="yes" group="Meta Data"> |
| <a id="EngineInstancesextendsAnyRef"></a> |
| <a id="EngineInstances:EngineInstances"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="EngineInstances.html"><span class="name">EngineInstances</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@EngineInstancesextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Base trait of the <a href="EngineInstance.html" class="extype" name="org.apache.predictionio.data.storage.EngineInstance">EngineInstance</a> data access object |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Base trait of the <a href="EngineInstance.html" class="extype" name="org.apache.predictionio.data.storage.EngineInstance">EngineInstance</a> data access object |
| </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.EntityIdIxMap" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="EntityIdIxMapextendsSerializable"></a> |
| <a id="EntityIdIxMap:EntityIdIxMap"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="EntityIdIxMap.html"><span class="name">EntityIdIxMap</span></a><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@EntityIdIxMapextendsSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: Experimental ::</p><div class="fullcomment"><div class="comment cmt"><p>:: Experimental ::</p></div><dl class="attributes block"> <dt>Annotations</dt><dd> |
| <span class="name">@Experimental</span><span class="args">()</span> |
| |
| </dd></dl></div> |
| </li><li name="org.apache.predictionio.data.storage.EntityMap" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="EntityMap[A]extendsEntityIdIxMap"></a> |
| <a id="EntityMap[A]:EntityMap[A]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="EntityMap.html"><span class="name">EntityMap</span></a><span class="tparams">[<span name="A">A</span>]</span><span class="result"> extends <a href="EntityIdIxMap.html" class="extype" name="org.apache.predictionio.data.storage.EntityIdIxMap">EntityIdIxMap</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@EntityMap[A]extendsEntityIdIxMap" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: Experimental ::</p><div class="fullcomment"><div class="comment cmt"><p>:: Experimental ::</p></div><dl class="attributes block"> <dt>Annotations</dt><dd> |
| <span class="name">@Experimental</span><span class="args">()</span> |
| |
| </dd></dl></div> |
| </li><li name="org.apache.predictionio.data.storage.EnvironmentService" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="EnvironmentServiceextendsAnyRef"></a> |
| <a id="EnvironmentService:EnvironmentService"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="EnvironmentService.html"><span class="name">EnvironmentService</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@EnvironmentServiceextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.predictionio.data.storage.EvaluationInstance" visbl="pub" data-isabs="false" fullComment="yes" group="Meta Data"> |
| <a id="EvaluationInstanceextendsProductwithSerializable"></a> |
| <a id="EvaluationInstance:EvaluationInstance"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="EvaluationInstance.html"><span class="name">EvaluationInstance</span></a><span class="params">(<span name="id">id: <span class="extype" name="scala.Predef.String">String</span> = <span class="symbol">""</span></span>, <span name="status">status: <span class="extype" name="scala.Predef.String">String</span> = <span class="symbol">""</span></span>, <span name="startTime">startTime: <span class="extype" name="com.github.nscala_time.time.TypeImports.DateTime">com.github.nscala_time.time.Imports.DateTime</span> = <span class="symbol">DateTime.now</span></span>, <span name="endTime">endTime: <span class="extype" name="com.github.nscala_time.time.TypeImports.DateTime">com.github.nscala_time.time.Imports.DateTime</span> = <span class="symbol">DateTime.now</span></span>, <span name="evaluationClass">evaluationClass: <span class="extype" name="scala.Predef.String">String</span> = <span class="symbol">""</span></span>, <span name="engineParamsGeneratorClass">engineParamsGeneratorClass: <span class="extype" name="scala.Predef.String">String</span> = <span class="symbol">""</span></span>, <span name="batch">batch: <span class="extype" name="scala.Predef.String">String</span> = <span class="symbol">""</span></span>, <span name="env">env: <span class="extype" name="scala.Predef.Map">Map</span>[<span class="extype" name="scala.Predef.String">String</span>, <span class="extype" name="scala.Predef.String">String</span>] = <span class="symbol">Map.empty</span></span>, <span name="sparkConf">sparkConf: <span class="extype" name="scala.Predef.Map">Map</span>[<span class="extype" name="scala.Predef.String">String</span>, <span class="extype" name="scala.Predef.String">String</span>] = <span class="symbol">Map.empty</span></span>, <span name="evaluatorResults">evaluatorResults: <span class="extype" name="scala.Predef.String">String</span> = <span class="symbol">""</span></span>, <span name="evaluatorResultsHTML">evaluatorResultsHTML: <span class="extype" name="scala.Predef.String">String</span> = <span class="symbol">""</span></span>, <span name="evaluatorResultsJSON">evaluatorResultsJSON: <span class="extype" name="scala.Predef.String">String</span> = <span class="symbol">""</span></span>)</span><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Product" class="extype" target="_top">Product</a> with <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@EvaluationInstanceextendsProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Stores meta information for each evaluation instance.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Stores meta information for each evaluation instance. |
| </p></div><dl class="paramcmts block"><dt class="param">id</dt><dd class="cmt"><p>Instance ID.</p></dd><dt class="param">status</dt><dd class="cmt"><p>Status of this instance.</p></dd><dt class="param">startTime</dt><dd class="cmt"><p>Start time of this instance.</p></dd><dt class="param">endTime</dt><dd class="cmt"><p>End time of this instance.</p></dd><dt class="param">evaluationClass</dt><dd class="cmt"><p>Evaluation class name of this instance.</p></dd><dt class="param">engineParamsGeneratorClass</dt><dd class="cmt"><p>Engine parameters generator class name of this instance.</p></dd><dt class="param">batch</dt><dd class="cmt"><p>Batch label of this instance.</p></dd><dt class="param">env</dt><dd class="cmt"><p>The environment in which this instance was created.</p></dd><dt class="param">evaluatorResults</dt><dd class="cmt"><p>Results of the evaluator.</p></dd><dt class="param">evaluatorResultsHTML</dt><dd class="cmt"><p>HTML results of the evaluator.</p></dd><dt class="param">evaluatorResultsJSON</dt><dd class="cmt"><p>JSON results of the evaluator.</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.EvaluationInstanceSerializer" visbl="pub" data-isabs="false" fullComment="no" group="Meta Data"> |
| <a id="EvaluationInstanceSerializerextendsCustomSerializer[org.apache.predictionio.data.storage.EvaluationInstance]"></a> |
| <a id="EvaluationInstanceSerializer:EvaluationInstanceSerializer"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="EvaluationInstanceSerializer.html"><span class="name">EvaluationInstanceSerializer</span></a><span class="result"> extends <span class="extype" name="org.json4s.CustomSerializer">CustomSerializer</span>[<a href="EvaluationInstance.html" class="extype" name="org.apache.predictionio.data.storage.EvaluationInstance">EvaluationInstance</a>]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@EvaluationInstanceSerializerextendsCustomSerializer[org.apache.predictionio.data.storage.EvaluationInstance]" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| JSON4S serializer for <a href="EvaluationInstance.html" class="extype" name="org.apache.predictionio.data.storage.EvaluationInstance">EvaluationInstance</a> |
| </p> |
| </li><li name="org.apache.predictionio.data.storage.EvaluationInstances" visbl="pub" data-isabs="true" fullComment="yes" group="Meta Data"> |
| <a id="EvaluationInstancesextendsAnyRef"></a> |
| <a id="EvaluationInstances:EvaluationInstances"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="EvaluationInstances.html"><span class="name">EvaluationInstances</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@EvaluationInstancesextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Base trait of the <a href="EvaluationInstance.html" class="extype" name="org.apache.predictionio.data.storage.EvaluationInstance">EvaluationInstance</a> data access object |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Base trait of the <a href="EvaluationInstance.html" class="extype" name="org.apache.predictionio.data.storage.EvaluationInstance">EvaluationInstance</a> data access object |
| </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.Event" visbl="pub" data-isabs="false" fullComment="yes" group="Event Data"> |
| <a id="EventextendsProductwithSerializable"></a> |
| <a id="Event:Event"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Event.html"><span class="name">Event</span></a><span class="params">(<span name="eventId">eventId: <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="event">event: <span class="extype" name="scala.Predef.String">String</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="targetEntityType">targetEntityType: <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>[<span class="extype" name="scala.Predef.String">String</span>] = <span class="symbol">None</span></span>, <span name="properties">properties: <a href="DataMap.html" class="extype" name="org.apache.predictionio.data.storage.DataMap">DataMap</a> = <span class="symbol"><span class="name"><a href="DataMap$.html">DataMap()</a></span></span></span>, <span name="eventTime">eventTime: <span class="extype" name="org.joda.time.DateTime">DateTime</span> = <span class="symbol"><span class="name"><a href="../../../../package.html">DateTime.now</a></span></span></span>, <span name="tags">tags: <span class="extype" name="scala.Seq">Seq</span>[<span class="extype" name="scala.Predef.String">String</span>] = <span class="symbol">Nil</span></span>, <span name="prId">prId: <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="creationTime">creationTime: <span class="extype" name="org.joda.time.DateTime">DateTime</span> = <span class="symbol"><span class="name"><a href="../../../../package.html">DateTime.now</a></span></span></span>)</span><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Product" class="extype" target="_top">Product</a> with <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@EventextendsProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Each event in the Event Store can be represented by fields in this case |
| class.</p><div class="fullcomment"><div class="comment cmt"><p>Each event in the Event Store can be represented by fields in this case |
| class. |
| </p></div><dl class="paramcmts block"><dt class="param">eventId</dt><dd class="cmt"><p>Unique ID of this event.</p></dd><dt class="param">event</dt><dd class="cmt"><p>Name of this event.</p></dd><dt class="param">entityType</dt><dd class="cmt"><p>Type of the entity associated with this event.</p></dd><dt class="param">entityId</dt><dd class="cmt"><p>ID of the entity associated with this event.</p></dd><dt class="param">targetEntityType</dt><dd class="cmt"><p>Type of the target entity associated with this |
| event.</p></dd><dt class="param">targetEntityId</dt><dd class="cmt"><p>ID of the target entity associated with this event.</p></dd><dt class="param">properties</dt><dd class="cmt"><p>Properties associated with this event.</p></dd><dt class="param">eventTime</dt><dd class="cmt"><p>Time of the happening of this event.</p></dd><dt class="param">tags</dt><dd class="cmt"><p>Tags of this event.</p></dd><dt class="param">prId</dt><dd class="cmt"><p>PredictedResultId of this event.</p></dd><dt class="param">creationTime</dt><dd class="cmt"><p>Time of creation in the system of this event.</p></dd></dl></div> |
| </li><li name="org.apache.predictionio.data.storage.LEvents" visbl="pub" data-isabs="true" fullComment="yes" group="Event Data"> |
| <a id="LEventsextendsAnyRef"></a> |
| <a id="LEvents:LEvents"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="LEvents.html"><span class="name">LEvents</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@LEventsextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: 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.</p><div class="fullcomment"><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> |
| </li><li name="org.apache.predictionio.data.storage.Model" visbl="pub" data-isabs="false" fullComment="yes" group="Model Data"> |
| <a id="ModelextendsProductwithSerializable"></a> |
| <a id="Model:Model"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Model.html"><span class="name">Model</span></a><span class="params">(<span name="id">id: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="models">models: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Array" class="extype" target="_top">Array</a>[<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Byte" class="extype" target="_top">Byte</a>]</span>)</span><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Product" class="extype" target="_top">Product</a> with <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@ModelextendsProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Stores model for each engine instance |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Stores model for each engine instance |
| </p></div><dl class="paramcmts block"><dt class="param">id</dt><dd class="cmt"><p>ID of the model, which should be the same as engine instance ID</p></dd><dt class="param">models</dt><dd class="cmt"><p>Trained models of all algorithms</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.ModelSerializer" visbl="pub" data-isabs="false" fullComment="yes" group="Model Data"> |
| <a id="ModelSerializerextendsCustomSerializer[org.apache.predictionio.data.storage.Model]"></a> |
| <a id="ModelSerializer:ModelSerializer"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="ModelSerializer.html"><span class="name">ModelSerializer</span></a><span class="result"> extends <span class="extype" name="org.json4s.CustomSerializer">CustomSerializer</span>[<a href="Model.html" class="extype" name="org.apache.predictionio.data.storage.Model">Model</a>]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@ModelSerializerextendsCustomSerializer[org.apache.predictionio.data.storage.Model]" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| JSON4S serializer for <a href="Model.html" class="extype" name="org.apache.predictionio.data.storage.Model">Model</a> |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| JSON4S serializer for <a href="Model.html" class="extype" name="org.apache.predictionio.data.storage.Model">Model</a> |
| </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.Models" visbl="pub" data-isabs="true" fullComment="yes" group="Model Data"> |
| <a id="ModelsextendsAnyRef"></a> |
| <a id="Models:Models"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="Models.html"><span class="name">Models</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@ModelsextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Base trait for of the <a href="Model.html" class="extype" name="org.apache.predictionio.data.storage.Model">Model</a> data access object |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Base trait for of the <a href="Model.html" class="extype" name="org.apache.predictionio.data.storage.Model">Model</a> data access object |
| </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.NullModel" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="NullModelextendsProductwithSerializable"></a> |
| <a id="NullModel:NullModel"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="NullModel.html"><span class="name">NullModel</span></a><span class="params">()</span><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Product" class="extype" target="_top">Product</a> with <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@NullModelextendsProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.predictionio.data.storage.PEvents" visbl="pub" data-isabs="true" fullComment="yes" group="Event Data"> |
| <a id="PEventsextendsSerializable"></a> |
| <a id="PEvents:PEvents"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="PEvents.html"><span class="name">PEvents</span></a><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@PEventsextendsSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Base trait of a data access object that returns <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> related RDD data |
| structure.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Base trait of a data access object that returns <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> related RDD data |
| structure. Engine developers should use |
| <a href="../store/PEventStore$.html" class="extype" name="org.apache.predictionio.data.store.PEventStore">org.apache.predictionio.data.store.PEventStore</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> |
| </li><li name="org.apache.predictionio.data.storage.PropertyMap" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="PropertyMapextendsDataMap"></a> |
| <a id="PropertyMap:PropertyMap"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="PropertyMap.html"><span class="name">PropertyMap</span></a><span class="result"> extends <a href="DataMap.html" class="extype" name="org.apache.predictionio.data.storage.DataMap">DataMap</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@PropertyMapextendsDataMap" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">A PropertyMap stores aggregated properties of the entity.</p><div class="fullcomment"><div class="comment cmt"><p>A PropertyMap stores aggregated properties of the entity. |
| Internally it is a Map |
| whose keys are property names and values are corresponding JSON values |
| respectively. Use the get() method to retrieve the value of mandatory |
| property or use getOpt() to retrieve the value of the optional property. |
| </p></div></div> |
| </li><li name="org.apache.predictionio.data.storage.StorageClientConfig" visbl="pub" data-isabs="false" fullComment="yes" group="Storage System"> |
| <a id="StorageClientConfigextendsProductwithSerializable"></a> |
| <a id="StorageClientConfig:StorageClientConfig"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="StorageClientConfig.html"><span class="name">StorageClientConfig</span></a><span class="params">(<span name="parallel">parallel: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a> = <span class="symbol">false</span></span>, <span name="test">test: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a> = <span class="symbol">false</span></span>, <span name="properties">properties: <span class="extype" name="scala.Predef.Map">Map</span>[<span class="extype" name="scala.Predef.String">String</span>, <span class="extype" name="scala.Predef.String">String</span>] = <span class="symbol">Map.empty</span></span>)</span><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Product" class="extype" target="_top">Product</a> with <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@StorageClientConfigextendsProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| A wrapper of storage client configuration that will be populated by |
| PredictionIO automatically, and passed to the StorageClient during |
| instantiation.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| A wrapper of storage client configuration that will be populated by |
| PredictionIO automatically, and passed to the StorageClient during |
| instantiation. |
| </p></div><dl class="paramcmts block"><dt class="param">parallel</dt><dd class="cmt"><p>This is set to true by PredictionIO when the storage client |
| is instantiated in a parallel data source.</p></dd><dt class="param">test</dt><dd class="cmt"><p>This is set to true by PredictionIO when tests are being run.</p></dd><dt class="param">properties</dt><dd class="cmt"><p>This is populated by PredictionIO automatically from |
| environmental configuration variables. If you have these |
| variables,</p><ul><li>PIO_STORAGE_SOURCES_PGSQL_TYPE=jdbc</li><li>PIO_STORAGE_SOURCES_PGSQL_USERNAME=abc</li><li>PIO_STORAGE_SOURCES_PGSQL_PASSWORD=xyz |
| this field will be filled as a map of string to string:</li><li>TYPE -> jdbc</li><li>USERNAME -> abc</li><li>PASSWORD -> xyz</li></ul></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.StorageClientException" visbl="pub" data-isabs="false" fullComment="yes" group="Storage System"> |
| <a id="StorageClientExceptionextendsRuntimeException"></a> |
| <a id="StorageClientException:StorageClientException"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="StorageClientException.html"><span class="name">StorageClientException</span></a><span class="result"> extends <span class="extype" name="scala.RuntimeException">RuntimeException</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@StorageClientExceptionextendsRuntimeException" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Thrown when a StorageClient runs into an exceptional condition |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Thrown when a StorageClient runs into an exceptional condition |
| </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.StorageException" visbl="pub" data-isabs="false" fullComment="yes" group="Storage System"> |
| <a id="StorageExceptionextendsException"></a> |
| <a id="StorageException:StorageException"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="StorageException.html"><span class="name">StorageException</span></a><span class="result"> extends <span class="extype" name="scala.Exception">Exception</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@StorageExceptionextendsException" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Thrown by data access objects when they run into exceptional conditions |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Thrown by data access objects when they run into exceptional conditions |
| </p></div><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>Value Members</h3> |
| <ol><li name="org.apache.predictionio.data.storage.BatchEventsJson4sSupport" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="BatchEventsJson4sSupport"></a> |
| <a id="BatchEventsJson4sSupport:BatchEventsJson4sSupport"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="BatchEventsJson4sSupport$.html"><span class="name">BatchEventsJson4sSupport</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@BatchEventsJson4sSupport" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><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.BiMap" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="BiMap"></a> |
| <a id="BiMap:BiMap"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="BiMap$.html"><span class="name">BiMap</span></a><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@BiMap" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.predictionio.data.storage.Channel" visbl="pub" data-isabs="false" fullComment="yes" group="Meta Data"> |
| <a id="Channel"></a> |
| <a id="Channel:Channel"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Channel$.html"><span class="name">Channel</span></a><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@Channel" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Companion object of <a href="Channel.html" class="extype" name="org.apache.predictionio.data.storage.Channel">Channel</a> |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Companion object of <a href="Channel.html" class="extype" name="org.apache.predictionio.data.storage.Channel">Channel</a> |
| </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.DataMap" visbl="pub" data-isabs="false" fullComment="no" group="Event Data"> |
| <a id="DataMap"></a> |
| <a id="DataMap:DataMap"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="DataMap$.html"><span class="name">DataMap</span></a><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@DataMap" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Companion object of the <a href="DataMap.html" class="extype" name="org.apache.predictionio.data.storage.DataMap">DataMap</a> class |
| </p> |
| </li><li name="org.apache.predictionio.data.storage.DateTimeJson4sSupport" visbl="pub" data-isabs="false" fullComment="yes" group="Common"> |
| <a id="DateTimeJson4sSupport"></a> |
| <a id="DateTimeJson4sSupport:DateTimeJson4sSupport"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="DateTimeJson4sSupport$.html"><span class="name">DateTimeJson4sSupport</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@DateTimeJson4sSupport" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| JSON4S serializer for Joda-Time |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| JSON4S serializer for Joda-Time |
| </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.EntityIdIxMap" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="EntityIdIxMap"></a> |
| <a id="EntityIdIxMap:EntityIdIxMap"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="EntityIdIxMap$.html"><span class="name">EntityIdIxMap</span></a><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@EntityIdIxMap" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: Experimental ::</p><div class="fullcomment"><div class="comment cmt"><p>:: Experimental ::</p></div><dl class="attributes block"> <dt>Annotations</dt><dd> |
| <span class="name">@Experimental</span><span class="args">()</span> |
| |
| </dd></dl></div> |
| </li><li name="org.apache.predictionio.data.storage.EnvironmentFactory" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="EnvironmentFactory"></a> |
| <a id="EnvironmentFactory:EnvironmentFactory"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="EnvironmentFactory$.html"><span class="name">EnvironmentFactory</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@EnvironmentFactory" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.predictionio.data.storage.EventJson4sSupport" visbl="pub" data-isabs="false" fullComment="yes" group="Event Data"> |
| <a id="EventJson4sSupport"></a> |
| <a id="EventJson4sSupport:EventJson4sSupport"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="EventJson4sSupport$.html"><span class="name">EventJson4sSupport</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@EventJson4sSupport" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Support library for dealing with <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> and JSON4S |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Support library for dealing with <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a> and JSON4S |
| </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.EventValidation" visbl="pub" data-isabs="false" fullComment="yes" group="Event Data"> |
| <a id="EventValidation"></a> |
| <a id="EventValidation:EventValidation"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="EventValidation$.html"><span class="name">EventValidation</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@EventValidation" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Utilities for validating <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 :: |
| Utilities for validating <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a>s |
| </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.LEventAggregator" visbl="pub" data-isabs="false" fullComment="yes" group="Event Data"> |
| <a id="LEventAggregator"></a> |
| <a id="LEventAggregator:LEventAggregator"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="LEventAggregator$.html"><span class="name">LEventAggregator</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@LEventAggregator" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: DeveloperApi :: |
| Provides aggregation support of <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a>s to <a href="LEvents.html" class="extype" name="org.apache.predictionio.data.storage.LEvents">LEvents</a>.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: |
| Provides aggregation support of <a href="Event.html" class="extype" name="org.apache.predictionio.data.storage.Event">Event</a>s to <a href="LEvents.html" class="extype" name="org.apache.predictionio.data.storage.LEvents">LEvents</a>. 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> |
| </li><li name="org.apache.predictionio.data.storage.PropertyMap" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="PropertyMap"></a> |
| <a id="PropertyMap:PropertyMap"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="PropertyMap$.html"><span class="name">PropertyMap</span></a><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@PropertyMap" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Companion object of the <a href="PropertyMap.html" class="extype" name="org.apache.predictionio.data.storage.PropertyMap">PropertyMap</a> class.</p> |
| </li><li name="org.apache.predictionio.data.storage.Storage" visbl="pub" data-isabs="false" fullComment="yes" group="Storage System"> |
| <a id="Storage"></a> |
| <a id="Storage:Storage"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Storage$.html"><span class="name">Storage</span></a><span class="result"> extends <span class="extype" name="grizzled.slf4j.Logging">Logging</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.predictionio.data.storage.package@Storage" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Backend-agnostic data storage layer with lazy initialization.</p><div class="fullcomment"><div class="comment cmt"><p>Backend-agnostic data storage layer with lazy initialization. Use this |
| object when you need to interface with Event Store in your engine. |
| </p></div></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="Common"> |
| <h3>Common</h3> |
| |
| </div><div class="group" name="Event Data"> |
| <h3>Event Data</h3> |
| |
| </div><div class="group" name="Meta Data"> |
| <h3>Meta Data</h3> |
| |
| </div><div class="group" name="Model Data"> |
| <h3>Model Data</h3> |
| |
| </div><div class="group" name="Storage System"> |
| <h3>Storage System</h3> |
| |
| </div><div class="group" name="Ungrouped"> |
| <h3>Ungrouped</h3> |
| |
| </div> |
| </div> |
| |
| </div> |
| |
| <div id="tooltip"></div> |
| |
| <div id="footer"> </div> |
| |
| |
| </body> |
| </html> |
