GORA-490 added package-info files and edited javadocs for gora-dynamodb
Project: http://git-wip-us.apache.org/repos/asf/gora/repo Commit: http://git-wip-us.apache.org/repos/asf/gora/commit/7bfbdd06 Tree: http://git-wip-us.apache.org/repos/asf/gora/tree/7bfbdd06 Diff: http://git-wip-us.apache.org/repos/asf/gora/diff/7bfbdd06 Branch: refs/heads/master Commit: 7bfbdd06dca8d8b3afa110b21d9a014fc1c5bf5c Parents: f6b0039 Author: cihad guzel <[email protected]> Authored: Thu Aug 25 00:24:03 2016 +0300 Committer: cihad guzel <[email protected]> Committed: Thu Aug 25 01:37:57 2016 +0300 ---------------------------------------------------------------------- .../dynamodb/compiler/GoraDynamoDBCompiler.java | 60 ++++++++------------ .../gora/dynamodb/compiler/package-info.java | 20 +++++++ .../gora/dynamodb/query/package-info.java | 21 +++++++ .../gora/dynamodb/store/DynamoDBStore.java | 13 ++++- .../gora/dynamodb/store/package-info.java | 20 +++++++ .../org/apache/gora/dynamodb/package-info.java | 21 +++++++ 6 files changed, 117 insertions(+), 38 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/gora/blob/7bfbdd06/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/compiler/GoraDynamoDBCompiler.java ---------------------------------------------------------------------- diff --git a/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/compiler/GoraDynamoDBCompiler.java b/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/compiler/GoraDynamoDBCompiler.java index 6a0e51d..07e3447 100644 --- a/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/compiler/GoraDynamoDBCompiler.java +++ b/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/compiler/GoraDynamoDBCompiler.java @@ -59,8 +59,7 @@ public class GoraDynamoDBCompiler { /** * GoraDynamoDBCompiler * - * @param File - * where the data bean will be written. + * @param dest where the data bean will be written. */ private GoraDynamoDBCompiler(File dest) { this.dest = dest; @@ -82,15 +81,12 @@ public class GoraDynamoDBCompiler { } /** - * Method in charge of compiling a specific table using a key schema and a set + * Method in charge of compiling a specific table using a key schema and a set * of attributes - * @param dest2 - * @param pTableNameTable - * name - * @param pKeySchemaKey - * schema used - * @param pItemsList - * of items belonging to a specific table + * + * @param pTableName + * @param arrayList + * @param map */ private void compile(String pTableName, ArrayList<KeySchemaElement> arrayList, Map<String, String> map){ try { @@ -117,10 +113,9 @@ public class GoraDynamoDBCompiler { /** * Receives a list of all items and creates getters and setters for them - * @param pItemsThe - * items belonging to the table - * @param pIdenThe - * number of spaces used for identation + * + * @param pItems The items belonging to the table + * @param pIden The number of spaces used for identation * @throws IOException */ private void setItems(Map<String, String> pItems, int pIden) @@ -141,12 +136,10 @@ public class GoraDynamoDBCompiler { /** * Creates item getters and setters - * @param pItemNameItem - * 's name - * @param pItemTypeItem - * 's type - * @param pIdenNumber - * of spaces used for indentation + * + * @param pItemName Item's name + * @param pItemType Item's type + * @param pIden Number of spaces used for indentation * @throws IOException */ private void setItemMethods(String pItemName, String pItemType, int pIden) @@ -162,11 +155,10 @@ public class GoraDynamoDBCompiler { } /** - * Creates key getters and setters - * @param pKeySchemaThe - * key schema for a specific table - * @param pIdenNumber - * of spaces used for indentation + * Creates key getters and setters + * + * @param pKeySchema The key schema for a specific table + * @param pIden Number of spaces used for indentation * @throws IOException */ private void setKeyMethods(KeySchemaElement pKeySchema, String attType, @@ -228,8 +220,8 @@ public class GoraDynamoDBCompiler { /** * Returns camel case version of a string - * @param sString - * to be camelcasified + * + * @param s String to be camelcasified * @return */ private static String camelCasify(String s) { @@ -238,10 +230,9 @@ public class GoraDynamoDBCompiler { /** * Starts the java generated class file - * @param nameClass - * name - * @param space - * spacing + * + * @param name Class name + * @param space spacing * @throws IOException */ private void startFile(String name, String space) throws IOException { @@ -320,10 +311,9 @@ public class GoraDynamoDBCompiler { /** * Writes a line within the output stream - * @param indentNumber - * of spaces used for indentation - * @param textText - * to be written + * + * @param indent Number of spaces used for indentation + * @param text Text to be written * @throws IOException */ private void line(int indent, String text) throws IOException { http://git-wip-us.apache.org/repos/asf/gora/blob/7bfbdd06/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/compiler/package-info.java ---------------------------------------------------------------------- diff --git a/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/compiler/package-info.java b/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/compiler/package-info.java new file mode 100644 index 0000000..8021692 --- /dev/null +++ b/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/compiler/package-info.java @@ -0,0 +1,20 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * This package contains DynamoDB store related util class. + */ +package org.apache.gora.dynamodb.compiler; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/gora/blob/7bfbdd06/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/query/package-info.java ---------------------------------------------------------------------- diff --git a/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/query/package-info.java b/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/query/package-info.java new file mode 100644 index 0000000..b3a91d2 --- /dev/null +++ b/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/query/package-info.java @@ -0,0 +1,21 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * This package contains all the DynamoDB store query representation class as well as Result set representing class + * when query is executed over the DynamoDB dataStore. + */ +package org.apache.gora.dynamodb.query; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/gora/blob/7bfbdd06/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/store/DynamoDBStore.java ---------------------------------------------------------------------- diff --git a/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/store/DynamoDBStore.java b/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/store/DynamoDBStore.java index 1cb75ed..da190b4 100644 --- a/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/store/DynamoDBStore.java +++ b/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/store/DynamoDBStore.java @@ -189,6 +189,15 @@ public class DynamoDBStore<K, T extends Persistent> implements DataStore<K, T> { return this.getPreferredSchema(); } + /** + * Initialize the data store by reading the credentials, setting the client's properties up and + * reading the mapping file. Initialize is called when then the call to + * {@link org.apache.gora.store.DataStoreFactory#createDataStore} is made. + * + * @param keyClass + * @param persistentClass + * @param properties + */ @Override public void initialize(Class<K> keyClass, Class<T> persistentClass, Properties properties) { @@ -287,9 +296,7 @@ public class DynamoDBStore<K, T extends Persistent> implements DataStore<K, T> { /** * Reads the schema file and converts it into a data structure to be used - * - * @param pMapFile - * The schema file to be mapped into a table + * * @return DynamoDBMapping Object containing all necessary information to * create tables * @throws IOException http://git-wip-us.apache.org/repos/asf/gora/blob/7bfbdd06/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/store/package-info.java ---------------------------------------------------------------------- diff --git a/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/store/package-info.java b/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/store/package-info.java new file mode 100644 index 0000000..ee089b2 --- /dev/null +++ b/gora-dynamodb/src/main/java/org/apache/gora/dynamodb/store/package-info.java @@ -0,0 +1,20 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * This package contains all the DynamoDB store related classes. + */ +package org.apache.gora.dynamodb.store; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/gora/blob/7bfbdd06/gora-dynamodb/src/test/java/org/apache/gora/dynamodb/package-info.java ---------------------------------------------------------------------- diff --git a/gora-dynamodb/src/test/java/org/apache/gora/dynamodb/package-info.java b/gora-dynamodb/src/test/java/org/apache/gora/dynamodb/package-info.java new file mode 100644 index 0000000..707876f --- /dev/null +++ b/gora-dynamodb/src/test/java/org/apache/gora/dynamodb/package-info.java @@ -0,0 +1,21 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * Tests for <code>gora-dynamodb</code> including + * the test driver for {@link org.apache.gora.dynamodb.GoraDynamoDBTestDriver} + */ +package org.apache.gora.dynamodb; \ No newline at end of file
