GORA-490 added package-info files for gora-infinispan
Project: http://git-wip-us.apache.org/repos/asf/gora/repo Commit: http://git-wip-us.apache.org/repos/asf/gora/commit/a6cb1daf Tree: http://git-wip-us.apache.org/repos/asf/gora/tree/a6cb1daf Diff: http://git-wip-us.apache.org/repos/asf/gora/diff/a6cb1daf Branch: refs/heads/master Commit: a6cb1dafb5fdfe866a8b18a7e1bc8425d647e356 Parents: 35d9e99 Author: cihad guzel <[email protected]> Authored: Thu Aug 25 00:35:23 2016 +0300 Committer: cihad guzel <[email protected]> Committed: Thu Aug 25 01:37:57 2016 +0300 ---------------------------------------------------------------------- .../gora/infinispan/query/InfinispanQuery.java | 4 +++- .../gora/infinispan/query/package-info.java | 21 ++++++++++++++++++++ .../gora/infinispan/store/InfinispanStore.java | 12 +++++++++++ .../gora/infinispan/store/package-info.java | 20 +++++++++++++++++++ .../apache/gora/infinispan/package-info.java | 21 ++++++++++++++++++++ 5 files changed, 77 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/gora/blob/a6cb1daf/gora-infinispan/src/main/java/org/apache/gora/infinispan/query/InfinispanQuery.java ---------------------------------------------------------------------- diff --git a/gora-infinispan/src/main/java/org/apache/gora/infinispan/query/InfinispanQuery.java b/gora-infinispan/src/main/java/org/apache/gora/infinispan/query/InfinispanQuery.java index 9e0b62f..332cceb 100644 --- a/gora-infinispan/src/main/java/org/apache/gora/infinispan/query/InfinispanQuery.java +++ b/gora-infinispan/src/main/java/org/apache/gora/infinispan/query/InfinispanQuery.java @@ -24,6 +24,7 @@ import org.apache.gora.filter.SingleFieldValueFilter; import org.apache.gora.infinispan.store.InfinispanStore; import org.apache.gora.persistency.impl.PersistentBase; import org.apache.gora.query.PartitionQuery; +import org.apache.gora.query.Query; import org.apache.gora.query.impl.QueryBase; import org.apache.hadoop.io.WritableUtils; import org.infinispan.avro.client.Support; @@ -43,7 +44,8 @@ import java.util.Arrays; import java.util.Collection; import java.util.List; -/* +/** + * Infinispan specific implementation of the {@link Query} interface. * * @author Pierre Sutra */ public class InfinispanQuery<K,T extends PersistentBase> http://git-wip-us.apache.org/repos/asf/gora/blob/a6cb1daf/gora-infinispan/src/main/java/org/apache/gora/infinispan/query/package-info.java ---------------------------------------------------------------------- diff --git a/gora-infinispan/src/main/java/org/apache/gora/infinispan/query/package-info.java b/gora-infinispan/src/main/java/org/apache/gora/infinispan/query/package-info.java new file mode 100644 index 0000000..8a73643 --- /dev/null +++ b/gora-infinispan/src/main/java/org/apache/gora/infinispan/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 Infinispan store query representation class as well as Result set representing class + * when query is executed over the Infinispan dataStore. + */ +package org.apache.gora.infinispan.query; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/gora/blob/a6cb1daf/gora-infinispan/src/main/java/org/apache/gora/infinispan/store/InfinispanStore.java ---------------------------------------------------------------------- diff --git a/gora-infinispan/src/main/java/org/apache/gora/infinispan/store/InfinispanStore.java b/gora-infinispan/src/main/java/org/apache/gora/infinispan/store/InfinispanStore.java index cb198ff..a6f9708 100644 --- a/gora-infinispan/src/main/java/org/apache/gora/infinispan/store/InfinispanStore.java +++ b/gora-infinispan/src/main/java/org/apache/gora/infinispan/store/InfinispanStore.java @@ -61,6 +61,15 @@ public class InfinispanStore<K, T extends PersistentBase> extends DataStoreBase< //Empty default constructor } + /** + * 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 synchronized void initialize(Class<K> keyClass, Class<T> persistentClass, Properties properties) { @@ -134,6 +143,9 @@ public class InfinispanStore<K, T extends PersistentBase> extends DataStoreBase< this.infinispanClient.dropCache(); } + /** + * Execute the query and return the result. + */ @Override public Result<K, T> execute(Query<K, T> query) { LOG.debug("execute()"); http://git-wip-us.apache.org/repos/asf/gora/blob/a6cb1daf/gora-infinispan/src/main/java/org/apache/gora/infinispan/store/package-info.java ---------------------------------------------------------------------- diff --git a/gora-infinispan/src/main/java/org/apache/gora/infinispan/store/package-info.java b/gora-infinispan/src/main/java/org/apache/gora/infinispan/store/package-info.java new file mode 100644 index 0000000..27e7926 --- /dev/null +++ b/gora-infinispan/src/main/java/org/apache/gora/infinispan/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 Infinispan store related classes. + */ +package org.apache.gora.infinispan.store; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/gora/blob/a6cb1daf/gora-infinispan/src/test/java/org/apache/gora/infinispan/package-info.java ---------------------------------------------------------------------- diff --git a/gora-infinispan/src/test/java/org/apache/gora/infinispan/package-info.java b/gora-infinispan/src/test/java/org/apache/gora/infinispan/package-info.java new file mode 100644 index 0000000..21a9984 --- /dev/null +++ b/gora-infinispan/src/test/java/org/apache/gora/infinispan/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-infinispan</code> including + * the test driver for {@link org.apache.gora.infinispan.GoraInfinispanTestDriver} + */ +package org.apache.gora.infinispan; \ No newline at end of file
