Repository: gora Updated Branches: refs/heads/master c2a095d4e -> da19993d2
GORA-234 Javadoc and java annotations in gora-core base (abstract) classes needs to be corrected Project: http://git-wip-us.apache.org/repos/asf/gora/repo Commit: http://git-wip-us.apache.org/repos/asf/gora/commit/da19993d Tree: http://git-wip-us.apache.org/repos/asf/gora/tree/da19993d Diff: http://git-wip-us.apache.org/repos/asf/gora/diff/da19993d Branch: refs/heads/master Commit: da19993d2d92b62b301cad167c71d7617a2944ad Parents: c2a095d Author: Lewis John McGibbney <lewis.j.mcgibb...@jpl.nasa.gov> Authored: Wed Jun 25 14:31:34 2014 -0700 Committer: Lewis John McGibbney <lewis.j.mcgibb...@jpl.nasa.gov> Committed: Wed Jun 25 14:31:34 2014 -0700 ---------------------------------------------------------------------- CHANGES.txt | 4 ++++ .../main/java/org/apache/gora/store/DataStore.java | 15 --------------- .../apache/gora/store/ws/impl/WSDataStoreBase.java | 10 +++++----- 3 files changed, 9 insertions(+), 20 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/gora/blob/da19993d/CHANGES.txt ---------------------------------------------------------------------- diff --git a/CHANGES.txt b/CHANGES.txt index 15bdc14..e35619b 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -4,6 +4,10 @@ Current Development 0.5-SNAPSHOT +* GORA-234 Javadoc and java annotations in gora-core base (abstract) classes needs to be corrected (tpalsulich via lewismc) + +* GORA-349 Update Datastore specific mapping documentation with new default root element (MJJoyce) via lewismc + * GORA-241 Properly document WebServiceBackedDataStore Interface (Tyler Palsulich) * GORA-347 Column attributes should be obtained using the column name and not the field name. (kaveh minooie, rmarroquin) http://git-wip-us.apache.org/repos/asf/gora/blob/da19993d/gora-core/src/main/java/org/apache/gora/store/DataStore.java ---------------------------------------------------------------------- diff --git a/gora-core/src/main/java/org/apache/gora/store/DataStore.java b/gora-core/src/main/java/org/apache/gora/store/DataStore.java index bec5e0e..e3b5411 100644 --- a/gora-core/src/main/java/org/apache/gora/store/DataStore.java +++ b/gora-core/src/main/java/org/apache/gora/store/DataStore.java @@ -49,7 +49,6 @@ public interface DataStore<K, T extends Persistent> { * @param keyClass the class of the keys * @param persistentClass the class of the persistent objects * @param properties extra metadata - * @throws IOException */ void initialize(Class<K> keyClass, Class<T> persistentClass, Properties properties); @@ -88,7 +87,6 @@ public interface DataStore<K, T extends Persistent> { * 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. - * @throws IOException */ void createSchema(); @@ -96,21 +94,18 @@ public interface DataStore<K, T extends Persistent> { * 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. - * @throws IOException */ void deleteSchema(); /** * Deletes all the data associated with the schema, but keeps the * schema (table or similar) intact. - * @throws IOException */ void truncateSchema(); /** * Returns whether the schema that holds the data exists in the datastore. * @return whether schema exists - * @throws IOException */ boolean schemaExists(); @@ -120,14 +115,12 @@ public interface DataStore<K, T extends Persistent> { * constructor) it throws an exception. Only use this function if you can * make sure that the key class has a no-arg constructor. * @return a new instance of the key object. - * @throws IOException */ K newKey(); /** * Returns a new instance of the managed persistent object. * @return a new instance of the managed persistent object. - * @throws IOException */ T newPersistent(); @@ -135,7 +128,6 @@ public interface DataStore<K, T extends Persistent> { * Returns the object corresponding to the given key fetching all the fields. * @param key the key of the object * @return the Object corresponding to the key or null if it cannot be found - * @throws IOException */ T get(K key); @@ -144,7 +136,6 @@ public interface DataStore<K, T extends Persistent> { * @param key the key of the object * @param fields the fields required in the object. Pass null, to retrieve all fields * @return the Object corresponding to the key or null if it cannot be found - * @throws IOException */ T get(K key, String[] fields); @@ -153,7 +144,6 @@ public interface DataStore<K, T extends Persistent> { * object with the same key already exists it will silently * be replaced. See also the note on * <a href="#visibility">visibility</a>. - * @throws IOException */ void put(K key, T obj); @@ -161,7 +151,6 @@ public interface DataStore<K, T extends Persistent> { * Deletes the object with the given key * @param key the key of the object * @return whether the object was successfully deleted - * @throws IOException */ boolean delete(K key); @@ -170,7 +159,6 @@ public interface DataStore<K, T extends Persistent> { * See also the note on <a href="#visibility">visibility</a>. * @param query matching records to this query will be deleted * @return number of deleted records - * @throws IOException */ long deleteByQuery(Query<K, T> query); @@ -178,7 +166,6 @@ public interface DataStore<K, T extends Persistent> { * Executes the given query and returns the results. * @param query the query to execute. * @return the results as a {@link Result} object. - * @throws IOException */ Result<K, T> execute(Query<K, T> query); @@ -204,7 +191,6 @@ public interface DataStore<K, T extends Persistent> { * optimize their writing by deferring the actual put / delete operations * until this moment. * See also the note on <a href="#visibility">visibility</a>. - * @throws IOException */ void flush(); @@ -225,7 +211,6 @@ public interface DataStore<K, T extends Persistent> { * 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. - * @throws IOException */ void close(); http://git-wip-us.apache.org/repos/asf/gora/blob/da19993d/gora-core/src/main/java/org/apache/gora/store/ws/impl/WSDataStoreBase.java ---------------------------------------------------------------------- diff --git a/gora-core/src/main/java/org/apache/gora/store/ws/impl/WSDataStoreBase.java b/gora-core/src/main/java/org/apache/gora/store/ws/impl/WSDataStoreBase.java index ac37b2c..e1d907b 100644 --- a/gora-core/src/main/java/org/apache/gora/store/ws/impl/WSDataStoreBase.java +++ b/gora-core/src/main/java/org/apache/gora/store/ws/impl/WSDataStoreBase.java @@ -121,7 +121,7 @@ implements DataStore<K, T>{ /** * Reads fields from an object - * @param obj + * @param obj Object to read from. * @throws Exception */ public void readFields(Object obj) throws Exception { @@ -129,7 +129,7 @@ implements DataStore<K, T>{ /** * Writes an object - * @param obj + * @param obj Object to write. * @throws Exception */ public void write(Object obj) throws Exception { @@ -175,8 +175,8 @@ implements DataStore<K, T>{ } /** - * Gets web service provider name - * @return + * Get the service provider name. + * @return the service provider name. */ public String getWSProvider() { return wsProvider; @@ -184,7 +184,7 @@ implements DataStore<K, T>{ /** * Sets web service provider name - * @param wsProvider + * @param wsProvider Name to set the service provider to. */ public void setWsProvider(String wsProvider) { this.wsProvider = wsProvider;
