| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_25) on Fri May 31 18:58:05 PDT 2013 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| DataStore (Apache Gora 0.2 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2013-05-31"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DataStore (Apache Gora 0.2 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DataStore.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../../../org/apache/gora/store/DataStoreFactory.html" title="class in org.apache.gora.store"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/gora/store/DataStore.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="DataStore.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.gora.store</FONT> |
| <BR> |
| Interface DataStore<K,T extends <A HREF="../../../../org/apache/gora/persistency/Persistent.html" title="interface in org.apache.gora.persistency">Persistent</A>></H2> |
| <DL> |
| <DT><DT><B>Type Parameters:</B><DD><CODE>K</CODE> - the class of keys in the datastore<DD><CODE>T</CODE> - the class of persistent objects in the datastore</DL> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</A>, org.apache.hadoop.conf.Configurable, org.apache.hadoop.io.Writable</DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../org/apache/gora/store/FileBackedDataStore.html" title="interface in org.apache.gora.store">FileBackedDataStore</A><K,T></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/gora/accumulo/store/AccumuloStore.html" title="class in org.apache.gora.accumulo.store">AccumuloStore</A>, <A HREF="../../../../org/apache/gora/avro/store/AvroStore.html" title="class in org.apache.gora.avro.store">AvroStore</A>, <A HREF="../../../../org/apache/gora/cassandra/store/CassandraStore.html" title="class in org.apache.gora.cassandra.store">CassandraStore</A>, <A HREF="../../../../org/apache/gora/avro/store/DataFileAvroStore.html" title="class in org.apache.gora.avro.store">DataFileAvroStore</A>, <A HREF="../../../../org/apache/gora/store/impl/DataStoreBase.html" title="class in org.apache.gora.store.impl">DataStoreBase</A>, <A HREF="../../../../org/apache/gora/store/impl/FileBackedDataStoreBase.html" title="class in org.apache.gora.store.impl">FileBackedDataStoreBase</A>, <A HREF="../../../../org/apache/gora/hbase/store/HBaseStore.html" title="class in org.apache.gora.hbase.store">HBaseStore</A>, <A HREF="../../../../org/apache/gora/memory/store/MemStore.html" title="class in org.apache.gora.memory.store">MemStore</A>, <A HREF="../../../../org/apache/gora/sql/store/SqlStore.html" title="class in org.apache.gora.sql.store">SqlStore</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>DataStore<K,T extends <A HREF="../../../../org/apache/gora/persistency/Persistent.html" title="interface in org.apache.gora.persistency">Persistent</A>></B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</A>, org.apache.hadoop.io.Writable, org.apache.hadoop.conf.Configurable</DL> |
| </PRE> |
| |
| <P> |
| DataStore handles actual object persistence. Objects can be persisted, |
| fetched, queried or deleted by the DataStore methods. DataStores can be |
| constructed by an instance of <A HREF="../../../../org/apache/gora/store/DataStoreFactory.html" title="class in org.apache.gora.store"><CODE>DataStoreFactory</CODE></A>. |
| |
| <p> DataStores implementations should be thread safe. |
| <p><a name="visibility"><b>Note:</b> Results of updates (<A HREF="../../../../org/apache/gora/store/DataStore.html#put(K, T)"><CODE>put(Object, Persistent)</CODE></A>, |
| <A HREF="../../../../org/apache/gora/store/DataStore.html#delete(K)"><CODE>delete(Object)</CODE></A> and <A HREF="../../../../org/apache/gora/store/DataStore.html#deleteByQuery(org.apache.gora.query.Query)"><CODE>deleteByQuery(Query)</CODE></A> operations) are |
| guaranteed to be visible to subsequent get / execute operations ONLY |
| after a subsequent call to <A HREF="../../../../org/apache/gora/store/DataStore.html#flush()"><CODE>flush()</CODE></A>. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#close()">close</A></B>()</CODE> |
| |
| <BR> |
| Close the DataStore.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#createSchema()">createSchema</A></B>()</CODE> |
| |
| <BR> |
| Creates the optional schema or table (or similar) in the datastore |
| to hold the objects.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#delete(K)">delete</A></B>(<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A> key)</CODE> |
| |
| <BR> |
| Deletes the object with the given key</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#deleteByQuery(org.apache.gora.query.Query)">deleteByQuery</A></B>(<A HREF="../../../../org/apache/gora/query/Query.html" title="interface in org.apache.gora.query">Query</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>,<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>> query)</CODE> |
| |
| <BR> |
| Deletes all the objects matching the query.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#deleteSchema()">deleteSchema</A></B>()</CODE> |
| |
| <BR> |
| Deletes the underlying schema or table (or similar) in the datastore |
| that holds the objects.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/gora/query/Result.html" title="interface in org.apache.gora.query">Result</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>,<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#execute(org.apache.gora.query.Query)">execute</A></B>(<A HREF="../../../../org/apache/gora/query/Query.html" title="interface in org.apache.gora.query">Query</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>,<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>> query)</CODE> |
| |
| <BR> |
| Executes the given query and returns the results.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#flush()">flush</A></B>()</CODE> |
| |
| <BR> |
| Forces the write caches to be flushed.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#get(K)">get</A></B>(<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A> key)</CODE> |
| |
| <BR> |
| Returns the object corresponding to the given key fetching all the fields.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#get(K, java.lang.String[])">get</A></B>(<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A> key, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] fields)</CODE> |
| |
| <BR> |
| Returns the object corresponding to the given key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/gora/persistency/BeanFactory.html" title="interface in org.apache.gora.persistency">BeanFactory</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>,<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#getBeanFactory()">getBeanFactory</A></B>()</CODE> |
| |
| <BR> |
| Returns the BeanFactory used by the DataStore</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> org.apache.hadoop.conf.Configuration</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#getConf()">getConf</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#getKeyClass()">getKeyClass</A></B>()</CODE> |
| |
| <BR> |
| Returns the class of the keys</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../org/apache/gora/query/PartitionQuery.html" title="interface in org.apache.gora.query">PartitionQuery</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>,<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#getPartitions(org.apache.gora.query.Query)">getPartitions</A></B>(<A HREF="../../../../org/apache/gora/query/Query.html" title="interface in org.apache.gora.query">Query</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>,<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>> query)</CODE> |
| |
| <BR> |
| Partitions the given query and returns a list of <A HREF="../../../../org/apache/gora/query/PartitionQuery.html" title="interface in org.apache.gora.query"><CODE>PartitionQuery</CODE></A>s, |
| which will execute on local data.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#getPersistentClass()">getPersistentClass</A></B>()</CODE> |
| |
| <BR> |
| Returns the class of the persistent objects</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#getSchemaName()">getSchemaName</A></B>()</CODE> |
| |
| <BR> |
| Returns the schema name given to this DataStore</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#initialize(java.lang.Class, java.lang.Class, java.util.Properties)">initialize</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>> keyClass, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>> persistentClass, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> properties)</CODE> |
| |
| <BR> |
| Initializes this DataStore.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#newKey()">newKey</A></B>()</CODE> |
| |
| <BR> |
| Returns a new instance of the key object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#newPersistent()">newPersistent</A></B>()</CODE> |
| |
| <BR> |
| Returns a new instance of the managed persistent object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/gora/query/Query.html" title="interface in org.apache.gora.query">Query</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>,<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#newQuery()">newQuery</A></B>()</CODE> |
| |
| <BR> |
| Constructs and returns a new Query.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#put(K, T)">put</A></B>(<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A> key, |
| <A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A> obj)</CODE> |
| |
| <BR> |
| Inserts the persistent object with the given key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#readFields(java.io.DataInput)">readFields</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</A> in)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#schemaExists()">schemaExists</A></B>()</CODE> |
| |
| <BR> |
| Returns whether the schema that holds the data exists in the datastore.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#setBeanFactory(org.apache.gora.persistency.BeanFactory)">setBeanFactory</A></B>(<A HREF="../../../../org/apache/gora/persistency/BeanFactory.html" title="interface in org.apache.gora.persistency">BeanFactory</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>,<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>> beanFactory)</CODE> |
| |
| <BR> |
| Sets the <A HREF="../../../../org/apache/gora/persistency/BeanFactory.html" title="interface in org.apache.gora.persistency"><CODE>BeanFactory</CODE></A> to use by the DataStore.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#setConf(org.apache.hadoop.conf.Configuration)">setConf</A></B>(org.apache.hadoop.conf.Configuration conf)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#setKeyClass(java.lang.Class)">setKeyClass</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>> keyClass)</CODE> |
| |
| <BR> |
| Sets the class of the keys</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#setPersistentClass(java.lang.Class)">setPersistentClass</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>> persistentClass)</CODE> |
| |
| <BR> |
| Sets the class of the persistent objects</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#truncateSchema()">truncateSchema</A></B>()</CODE> |
| |
| <BR> |
| Deletes all the data associated with the schema, but keeps the |
| schema (table or similar) intact.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/gora/store/DataStore.html#write(java.io.DataOutput)">write</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io">DataOutput</A> out)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="initialize(java.lang.Class, java.lang.Class, java.util.Properties)"><!-- --></A><H3> |
| initialize</H3> |
| <PRE> |
| void <B>initialize</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>> keyClass, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>> persistentClass, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> properties) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Initializes this DataStore. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>keyClass</CODE> - the class of the keys<DD><CODE>persistentClass</CODE> - the class of the persistent objects<DD><CODE>properties</CODE> - extra metadata |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setKeyClass(java.lang.Class)"><!-- --></A><H3> |
| setKeyClass</H3> |
| <PRE> |
| void <B>setKeyClass</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>> keyClass)</PRE> |
| <DL> |
| <DD>Sets the class of the keys |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>keyClass</CODE> - the class of keys</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getKeyClass()"><!-- --></A><H3> |
| getKeyClass</H3> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>> <B>getKeyClass</B>()</PRE> |
| <DL> |
| <DD>Returns the class of the keys |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>class of the keys</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPersistentClass(java.lang.Class)"><!-- --></A><H3> |
| setPersistentClass</H3> |
| <PRE> |
| void <B>setPersistentClass</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>> persistentClass)</PRE> |
| <DL> |
| <DD>Sets the class of the persistent objects |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>persistentClass</CODE> - class of persistent objects</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPersistentClass()"><!-- --></A><H3> |
| getPersistentClass</H3> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>> <B>getPersistentClass</B>()</PRE> |
| <DL> |
| <DD>Returns the class of the persistent objects |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>class of the persistent objects</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSchemaName()"><!-- --></A><H3> |
| getSchemaName</H3> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getSchemaName</B>()</PRE> |
| <DL> |
| <DD>Returns the schema name given to this DataStore |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>schema name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createSchema()"><!-- --></A><H3> |
| createSchema</H3> |
| <PRE> |
| void <B>createSchema</B>() |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Creates the optional schema or table (or similar) in the datastore |
| to hold the objects. If the schema is already created previously, |
| or the underlying data model does not support |
| or need this operation, the operation is ignored. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="deleteSchema()"><!-- --></A><H3> |
| deleteSchema</H3> |
| <PRE> |
| void <B>deleteSchema</B>() |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Deletes the underlying schema or table (or similar) in the datastore |
| that holds the objects. This also deletes all the data associated with |
| the schema. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="truncateSchema()"><!-- --></A><H3> |
| truncateSchema</H3> |
| <PRE> |
| void <B>truncateSchema</B>() |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Deletes all the data associated with the schema, but keeps the |
| schema (table or similar) intact. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="schemaExists()"><!-- --></A><H3> |
| schemaExists</H3> |
| <PRE> |
| boolean <B>schemaExists</B>() |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Returns whether the schema that holds the data exists in the datastore. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether schema exists |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newKey()"><!-- --></A><H3> |
| newKey</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A> <B>newKey</B>() |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Returns a new instance of the key object. If the object cannot be instantiated |
| (it the class is a Java primitive wrapper, or does not have no-arg |
| constructor) it throws an exception. Only use this function if you can |
| make sure that the key class has a no-arg constructor. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a new instance of the key object. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newPersistent()"><!-- --></A><H3> |
| newPersistent</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A> <B>newPersistent</B>() |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Returns a new instance of the managed persistent object. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a new instance of the managed persistent object. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="get(java.lang.Object)"><!-- --></A><A NAME="get(K)"><!-- --></A><H3> |
| get</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A> <B>get</B>(<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A> key) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Returns the object corresponding to the given key fetching all the fields. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the key of the object |
| <DT><B>Returns:</B><DD>the Object corresponding to the key or null if it cannot be found |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="get(java.lang.Object,java.lang.String[])"><!-- --></A><A NAME="get(K, java.lang.String[])"><!-- --></A><H3> |
| get</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A> <B>get</B>(<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A> key, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] fields) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Returns the object corresponding to the given key. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the key of the object<DD><CODE>fields</CODE> - the fields required in the object. Pass null, to retrieve all fields |
| <DT><B>Returns:</B><DD>the Object corresponding to the key or null if it cannot be found |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="put(java.lang.Object,org.apache.gora.persistency.Persistent)"><!-- --></A><A NAME="put(K, T)"><!-- --></A><H3> |
| put</H3> |
| <PRE> |
| void <B>put</B>(<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A> key, |
| <A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A> obj) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Inserts the persistent object with the given key. If an |
| object with the same key already exists it will silently |
| be replaced. See also the note on |
| <a href="#visibility">visibility</a>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="delete(java.lang.Object)"><!-- --></A><A NAME="delete(K)"><!-- --></A><H3> |
| delete</H3> |
| <PRE> |
| boolean <B>delete</B>(<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A> key) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Deletes the object with the given key |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the key of the object |
| <DT><B>Returns:</B><DD>whether the object was successfully deleted |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="deleteByQuery(org.apache.gora.query.Query)"><!-- --></A><H3> |
| deleteByQuery</H3> |
| <PRE> |
| long <B>deleteByQuery</B>(<A HREF="../../../../org/apache/gora/query/Query.html" title="interface in org.apache.gora.query">Query</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>,<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>> query) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Deletes all the objects matching the query. |
| See also the note on <a href="#visibility">visibility</a>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>query</CODE> - matching records to this query will be deleted |
| <DT><B>Returns:</B><DD>number of deleted records |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="execute(org.apache.gora.query.Query)"><!-- --></A><H3> |
| execute</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/gora/query/Result.html" title="interface in org.apache.gora.query">Result</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>,<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>> <B>execute</B>(<A HREF="../../../../org/apache/gora/query/Query.html" title="interface in org.apache.gora.query">Query</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>,<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>> query) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Executes the given query and returns the results. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>query</CODE> - the query to execute. |
| <DT><B>Returns:</B><DD>the results as a <A HREF="../../../../org/apache/gora/query/Result.html" title="interface in org.apache.gora.query"><CODE>Result</CODE></A> object. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newQuery()"><!-- --></A><H3> |
| newQuery</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/gora/query/Query.html" title="interface in org.apache.gora.query">Query</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>,<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>> <B>newQuery</B>()</PRE> |
| <DL> |
| <DD>Constructs and returns a new Query. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a new Query.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPartitions(org.apache.gora.query.Query)"><!-- --></A><H3> |
| getPartitions</H3> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../org/apache/gora/query/PartitionQuery.html" title="interface in org.apache.gora.query">PartitionQuery</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>,<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>>> <B>getPartitions</B>(<A HREF="../../../../org/apache/gora/query/Query.html" title="interface in org.apache.gora.query">Query</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>,<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>> query) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Partitions the given query and returns a list of <A HREF="../../../../org/apache/gora/query/PartitionQuery.html" title="interface in org.apache.gora.query"><CODE>PartitionQuery</CODE></A>s, |
| which will execute on local data. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>query</CODE> - the base query to create the partitions for. If the query |
| is null, then the data store returns the partitions for the default query |
| (returning every object) |
| <DT><B>Returns:</B><DD>a List of PartitionQuery's |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="flush()"><!-- --></A><H3> |
| flush</H3> |
| <PRE> |
| void <B>flush</B>() |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Forces the write caches to be flushed. DataStore implementations may |
| optimize their writing by deferring the actual put / delete operations |
| until this moment. |
| See also the note on <a href="#visibility">visibility</a>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setBeanFactory(org.apache.gora.persistency.BeanFactory)"><!-- --></A><H3> |
| setBeanFactory</H3> |
| <PRE> |
| void <B>setBeanFactory</B>(<A HREF="../../../../org/apache/gora/persistency/BeanFactory.html" title="interface in org.apache.gora.persistency">BeanFactory</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>,<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>> beanFactory)</PRE> |
| <DL> |
| <DD>Sets the <A HREF="../../../../org/apache/gora/persistency/BeanFactory.html" title="interface in org.apache.gora.persistency"><CODE>BeanFactory</CODE></A> to use by the DataStore. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>beanFactory</CODE> - the BeanFactory to use</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBeanFactory()"><!-- --></A><H3> |
| getBeanFactory</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/gora/persistency/BeanFactory.html" title="interface in org.apache.gora.persistency">BeanFactory</A><<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">K</A>,<A HREF="../../../../org/apache/gora/store/DataStore.html" title="type parameter in DataStore">T</A>> <B>getBeanFactory</B>()</PRE> |
| <DL> |
| <DD>Returns the BeanFactory used by the DataStore |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the BeanFactory used by the DataStore</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="close()"><!-- --></A><H3> |
| close</H3> |
| <PRE> |
| void <B>close</B>() |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Close the DataStore. This should release any resources held by the |
| implementation, so that the instance is ready for GC. |
| All other DataStore methods cannot be used after this |
| method was called. Subsequent calls of this method are ignored. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getConf()"><!-- --></A><H3> |
| getConf</H3> |
| <PRE> |
| org.apache.hadoop.conf.Configuration <B>getConf</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE>getConf</CODE> in interface <CODE>org.apache.hadoop.conf.Configurable</CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setConf(org.apache.hadoop.conf.Configuration)"><!-- --></A><H3> |
| setConf</H3> |
| <PRE> |
| void <B>setConf</B>(org.apache.hadoop.conf.Configuration conf)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE>setConf</CODE> in interface <CODE>org.apache.hadoop.conf.Configurable</CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="readFields(java.io.DataInput)"><!-- --></A><H3> |
| readFields</H3> |
| <PRE> |
| void <B>readFields</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</A> in) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE>readFields</CODE> in interface <CODE>org.apache.hadoop.io.Writable</CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="write(java.io.DataOutput)"><!-- --></A><H3> |
| write</H3> |
| <PRE> |
| void <B>write</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io">DataOutput</A> out) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE>write</CODE> in interface <CODE>org.apache.hadoop.io.Writable</CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DataStore.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../../../org/apache/gora/store/DataStoreFactory.html" title="class in org.apache.gora.store"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/gora/store/DataStore.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="DataStore.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2010-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
