GORA-490 added package-info and editted javadocs for gora-hbase
Project: http://git-wip-us.apache.org/repos/asf/gora/repo Commit: http://git-wip-us.apache.org/repos/asf/gora/commit/35d9e99b Tree: http://git-wip-us.apache.org/repos/asf/gora/tree/35d9e99b Diff: http://git-wip-us.apache.org/repos/asf/gora/diff/35d9e99b Branch: refs/heads/master Commit: 35d9e99b6a08008bf8f1318cfc364f188d3334f0 Parents: 7bfbdd0 Author: cihad guzel <cguz...@gmail.com> Authored: Thu Aug 25 00:27:43 2016 +0300 Committer: cihad guzel <cguz...@gmail.com> Committed: Thu Aug 25 01:37:57 2016 +0300 ---------------------------------------------------------------------- .../apache/gora/hbase/query/package-info.java | 21 ++++++++++++++++++++ .../org/apache/gora/hbase/store/HBaseStore.java | 9 +++++++++ .../apache/gora/hbase/store/package-info.java | 20 +++++++++++++++++++ .../apache/gora/hbase/util/package-info.java | 20 +++++++++++++++++++ .../org/apache/gora/hbase/package-info.java | 21 ++++++++++++++++++++ 5 files changed, 91 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/gora/blob/35d9e99b/gora-hbase/src/main/java/org/apache/gora/hbase/query/package-info.java ---------------------------------------------------------------------- diff --git a/gora-hbase/src/main/java/org/apache/gora/hbase/query/package-info.java b/gora-hbase/src/main/java/org/apache/gora/hbase/query/package-info.java new file mode 100644 index 0000000..31e888f --- /dev/null +++ b/gora-hbase/src/main/java/org/apache/gora/hbase/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 HBase store query representation class as well as Result set representing class + * when query is executed over the HBase dataStore. + */ +package org.apache.gora.hbase.query; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/gora/blob/35d9e99b/gora-hbase/src/main/java/org/apache/gora/hbase/store/HBaseStore.java ---------------------------------------------------------------------- diff --git a/gora-hbase/src/main/java/org/apache/gora/hbase/store/HBaseStore.java b/gora-hbase/src/main/java/org/apache/gora/hbase/store/HBaseStore.java index 00fe60b..ab7b2a5 100644 --- a/gora-hbase/src/main/java/org/apache/gora/hbase/store/HBaseStore.java +++ b/gora-hbase/src/main/java/org/apache/gora/hbase/store/HBaseStore.java @@ -106,6 +106,15 @@ implements Configurable { public HBaseStore() {//Empty Constrctor } + /** + * 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) { http://git-wip-us.apache.org/repos/asf/gora/blob/35d9e99b/gora-hbase/src/main/java/org/apache/gora/hbase/store/package-info.java ---------------------------------------------------------------------- diff --git a/gora-hbase/src/main/java/org/apache/gora/hbase/store/package-info.java b/gora-hbase/src/main/java/org/apache/gora/hbase/store/package-info.java new file mode 100644 index 0000000..ae0bd39 --- /dev/null +++ b/gora-hbase/src/main/java/org/apache/gora/hbase/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 HBase store related classes. + */ +package org.apache.gora.hbase.store; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/gora/blob/35d9e99b/gora-hbase/src/main/java/org/apache/gora/hbase/util/package-info.java ---------------------------------------------------------------------- diff --git a/gora-hbase/src/main/java/org/apache/gora/hbase/util/package-info.java b/gora-hbase/src/main/java/org/apache/gora/hbase/util/package-info.java new file mode 100644 index 0000000..480b6da --- /dev/null +++ b/gora-hbase/src/main/java/org/apache/gora/hbase/util/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 HBase store related util classes. + */ +package org.apache.gora.hbase.util; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/gora/blob/35d9e99b/gora-hbase/src/test/java/org/apache/gora/hbase/package-info.java ---------------------------------------------------------------------- diff --git a/gora-hbase/src/test/java/org/apache/gora/hbase/package-info.java b/gora-hbase/src/test/java/org/apache/gora/hbase/package-info.java new file mode 100644 index 0000000..fd6d941 --- /dev/null +++ b/gora-hbase/src/test/java/org/apache/gora/hbase/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-hbase</code> including + * the test driver for {@link org.apache.gora.hbase.GoraHBaseTestDriver} + */ +package org.apache.gora.hbase; \ No newline at end of file
