GORA-490 added package-info files and javadocs for gora-cassandra
Project: http://git-wip-us.apache.org/repos/asf/gora/repo Commit: http://git-wip-us.apache.org/repos/asf/gora/commit/f6b00394 Tree: http://git-wip-us.apache.org/repos/asf/gora/tree/f6b00394 Diff: http://git-wip-us.apache.org/repos/asf/gora/diff/f6b00394 Branch: refs/heads/master Commit: f6b00394db9f958add41f8aa4f00499e05f0ae87 Parents: 0cb1aee Author: cihad guzel <[email protected]> Authored: Thu Aug 25 00:12:12 2016 +0300 Committer: cihad guzel <[email protected]> Committed: Thu Aug 25 01:37:57 2016 +0300 ---------------------------------------------------------------------- .../gora/cassandra/query/CassandraQuery.java | 36 +++++++++++++++++++- .../gora/cassandra/query/CassandraResult.java | 27 ++++++++++++++- .../gora/cassandra/query/package-info.java | 21 ++++++++++++ .../cassandra/serializers/package-info.java | 20 +++++++++++ .../gora/cassandra/store/CassandraMapping.java | 3 ++ .../store/CassandraMappingManager.java | 3 ++ .../gora/cassandra/store/package-info.java | 20 +++++++++++ .../org/apache/gora/cassandra/package-info.java | 21 ++++++++++++ 8 files changed, 149 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/gora/blob/f6b00394/gora-cassandra/src/main/java/org/apache/gora/cassandra/query/CassandraQuery.java ---------------------------------------------------------------------- diff --git a/gora-cassandra/src/main/java/org/apache/gora/cassandra/query/CassandraQuery.java b/gora-cassandra/src/main/java/org/apache/gora/cassandra/query/CassandraQuery.java index e51cf2a..1e8d101 100644 --- a/gora-cassandra/src/main/java/org/apache/gora/cassandra/query/CassandraQuery.java +++ b/gora-cassandra/src/main/java/org/apache/gora/cassandra/query/CassandraQuery.java @@ -26,24 +26,48 @@ import org.apache.gora.query.Query; import org.apache.gora.query.impl.QueryBase; import org.apache.gora.store.DataStore; +/** + * Cassandra specific implementation of the {@link Query} interface. + */ public class CassandraQuery<K, T extends PersistentBase> extends QueryBase<K, T> { + /** + * Cassandra specific implementation of the {@link Query} interface. + */ private Query<K, T> query; /** * Maps Avro fields to Cassandra columns. */ private Map<String, List<String>> familyMap; - + + /** + * Constructor for the query + */ public CassandraQuery() { super(null); } + + /** + * Constructor for the query + * + * @param dataStore Data store used + * + */ public CassandraQuery(DataStore<K, T> dataStore) { super(dataStore); } + + /** + * Setter of familyMap. + */ public void setFamilyMap(Map<String, List<String>> familyMap) { this.familyMap = familyMap; } + + /** + * Getter of familyMap. + */ public Map<String, List<String>> getFamilyMap() { return familyMap; } @@ -61,9 +85,19 @@ public class CassandraQuery<K, T extends PersistentBase> extends QueryBase<K, T> } return columns; } + + /** + * + * @return get {@link org.apache.gora.cassandra.query.CassandraQuery} + */ public Query<K, T> getQuery() { return query; } + + /** + * + * @return set a {@link org.apache.gora.cassandra.query.CassandraQuery} + */ public void setQuery(Query<K, T> query) { this.query = query; } http://git-wip-us.apache.org/repos/asf/gora/blob/f6b00394/gora-cassandra/src/main/java/org/apache/gora/cassandra/query/CassandraResult.java ---------------------------------------------------------------------- diff --git a/gora-cassandra/src/main/java/org/apache/gora/cassandra/query/CassandraResult.java b/gora-cassandra/src/main/java/org/apache/gora/cassandra/query/CassandraResult.java index dc99258..a89c97c 100644 --- a/gora-cassandra/src/main/java/org/apache/gora/cassandra/query/CassandraResult.java +++ b/gora-cassandra/src/main/java/org/apache/gora/cassandra/query/CassandraResult.java @@ -35,11 +35,18 @@ import org.apache.gora.store.DataStore; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * CassandraResult specific implementation of the {@link org.apache.gora.query.Result} + * interface. + */ public class CassandraResult<K, T extends PersistentBase> extends ResultBase<K, T> { public static final Logger LOG = LoggerFactory.getLogger(CassandraResult.class); private int rowNumber; + /** + * Result set containing query results + */ private CassandraResultSet<K> cassandraResultSet; /** @@ -47,10 +54,20 @@ public class CassandraResult<K, T extends PersistentBase> extends ResultBase<K, */ private Map<String, String> reverseMap; + + /** + * Constructor for the result set + * + * @param dataStore Data store used + * @param query Query used + */ public CassandraResult(DataStore<K, T> dataStore, Query<K, T> query) { super(dataStore, query); } + /** + * Gets the next item + */ @Override protected boolean nextInner() throws IOException { if (this.rowNumber < this.cassandraResultSet.size()) { @@ -153,15 +170,23 @@ public class CassandraResult<K, T extends PersistentBase> extends ResultBase<K, } + /** + * Gets the items reading progress + */ @Override public float getProgress() throws IOException { return (((float) this.rowNumber) / this.cassandraResultSet.size()); } + /** + * Set the Result set containing query results + * + * @param cassandraResultSet + */ public void setResultSet(CassandraResultSet<K> cassandraResultSet) { this.cassandraResultSet = cassandraResultSet; } - + public void setReverseMap(Map<String, String> reverseMap) { this.reverseMap = reverseMap; } http://git-wip-us.apache.org/repos/asf/gora/blob/f6b00394/gora-cassandra/src/main/java/org/apache/gora/cassandra/query/package-info.java ---------------------------------------------------------------------- diff --git a/gora-cassandra/src/main/java/org/apache/gora/cassandra/query/package-info.java b/gora-cassandra/src/main/java/org/apache/gora/cassandra/query/package-info.java new file mode 100644 index 0000000..49faefa --- /dev/null +++ b/gora-cassandra/src/main/java/org/apache/gora/cassandra/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 Cassandra store query representation class as well as Result set representing class + * when query is executed over the Cassandra dataStore. + */ +package org.apache.gora.cassandra.query; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/gora/blob/f6b00394/gora-cassandra/src/main/java/org/apache/gora/cassandra/serializers/package-info.java ---------------------------------------------------------------------- diff --git a/gora-cassandra/src/main/java/org/apache/gora/cassandra/serializers/package-info.java b/gora-cassandra/src/main/java/org/apache/gora/cassandra/serializers/package-info.java new file mode 100644 index 0000000..5d22d94 --- /dev/null +++ b/gora-cassandra/src/main/java/org/apache/gora/cassandra/serializers/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 Cassandra store related util classes for serializer. + */ +package org.apache.gora.cassandra.serializers; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/gora/blob/f6b00394/gora-cassandra/src/main/java/org/apache/gora/cassandra/store/CassandraMapping.java ---------------------------------------------------------------------- diff --git a/gora-cassandra/src/main/java/org/apache/gora/cassandra/store/CassandraMapping.java b/gora-cassandra/src/main/java/org/apache/gora/cassandra/store/CassandraMapping.java index a748bb4..b7a7087 100644 --- a/gora-cassandra/src/main/java/org/apache/gora/cassandra/store/CassandraMapping.java +++ b/gora-cassandra/src/main/java/org/apache/gora/cassandra/store/CassandraMapping.java @@ -33,6 +33,9 @@ import org.jdom.Element; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * Mapping definitions for CouchDB. + */ public class CassandraMapping { public static final Logger LOG = LoggerFactory.getLogger(CassandraMapping.class); http://git-wip-us.apache.org/repos/asf/gora/blob/f6b00394/gora-cassandra/src/main/java/org/apache/gora/cassandra/store/CassandraMappingManager.java ---------------------------------------------------------------------- diff --git a/gora-cassandra/src/main/java/org/apache/gora/cassandra/store/CassandraMappingManager.java b/gora-cassandra/src/main/java/org/apache/gora/cassandra/store/CassandraMappingManager.java index 18ea7c8..6b46eec 100644 --- a/gora-cassandra/src/main/java/org/apache/gora/cassandra/store/CassandraMappingManager.java +++ b/gora-cassandra/src/main/java/org/apache/gora/cassandra/store/CassandraMappingManager.java @@ -31,6 +31,9 @@ import org.jdom.input.SAXBuilder; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * A builder for creating the mapper. + */ public class CassandraMappingManager { public static final Logger LOG = LoggerFactory.getLogger(CassandraMappingManager.class); http://git-wip-us.apache.org/repos/asf/gora/blob/f6b00394/gora-cassandra/src/main/java/org/apache/gora/cassandra/store/package-info.java ---------------------------------------------------------------------- diff --git a/gora-cassandra/src/main/java/org/apache/gora/cassandra/store/package-info.java b/gora-cassandra/src/main/java/org/apache/gora/cassandra/store/package-info.java new file mode 100644 index 0000000..e6d0176 --- /dev/null +++ b/gora-cassandra/src/main/java/org/apache/gora/cassandra/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 Cassandra store related classes. + */ +package org.apache.gora.cassandra.store; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/gora/blob/f6b00394/gora-cassandra/src/test/java/org/apache/gora/cassandra/package-info.java ---------------------------------------------------------------------- diff --git a/gora-cassandra/src/test/java/org/apache/gora/cassandra/package-info.java b/gora-cassandra/src/test/java/org/apache/gora/cassandra/package-info.java new file mode 100644 index 0000000..8a8eb40 --- /dev/null +++ b/gora-cassandra/src/test/java/org/apache/gora/cassandra/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-cassandra</code> including + * the test driver for {@link org.apache.gora.cassandra.GoraCassandraTestDriver} + */ +package org.apache.gora.cassandra; \ No newline at end of file
