From f2ce1aa6cc3b7d9dfdd72438be91b89868df61b9 Mon Sep 17 00:00:00 2001
From: ribeaudc <ribeaudc>
Date: Wed, 19 Nov 2008 11:35:52 +0000
Subject: [PATCH] [LMS-634] change: - 'IResultSetKeyProvider' renamed to
'IResultSetKeyGenerator'. - 'IResultSetRetriever' renamed to
'IOriginalDataProvider'.
SVN: 9034
---
.../resultset/CachedResultSetManager.java | 20 +++++++++----------
...riever.java => IOriginalDataProvider.java} | 6 +++---
...vider.java => IResultSetKeyGenerator.java} | 11 ++++++----
.../server/resultset/IResultSetManager.java | 4 ++--
.../web/server/GenericClientService.java | 10 +++++-----
.../resultset/CachedResultSetManagerTest.java | 6 +++---
6 files changed, 30 insertions(+), 27 deletions(-)
rename openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/{IResultSetRetriever.java => IOriginalDataProvider.java} (80%)
rename openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/{IResultSetKeyProvider.java => IResultSetKeyGenerator.java} (77%)
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/CachedResultSetManager.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/CachedResultSetManager.java
index 59d98c54bc7..82d0a6a0047 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/CachedResultSetManager.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/CachedResultSetManager.java
@@ -37,7 +37,7 @@ import ch.systemsx.cisd.openbis.generic.client.web.client.dto.SortInfo.SortDir;
/**
* A {@link IResultSetManager} implementation which caches the full data retrieved using
- * {@link IResultSetRetriever}.
+ * {@link IOriginalDataProvider}.
*
* @author Christian Ribeaud
*/
@@ -45,7 +45,7 @@ public final class CachedResultSetManager<K> implements IResultSetManager<K>, Se
{
private static final long serialVersionUID = 1L;
- private final IResultSetKeyProvider<K> resultSetKeyProvider;
+ private final IResultSetKeyGenerator<K> resultSetKeyProvider;
private static final Logger operationLog =
LogFactory.getLogger(LogCategory.OPERATION, CachedResultSetManager.class);
@@ -53,7 +53,7 @@ public final class CachedResultSetManager<K> implements IResultSetManager<K>, Se
@Private
final Map<K, List<?>> results = new HashMap<K, List<?>>();
- public CachedResultSetManager(final IResultSetKeyProvider<K> resultSetKeyProvider)
+ public CachedResultSetManager(final IResultSetKeyGenerator<K> resultSetKeyProvider)
{
this.resultSetKeyProvider = resultSetKeyProvider;
}
@@ -122,7 +122,7 @@ public final class CachedResultSetManager<K> implements IResultSetManager<K>, Se
//
public final synchronized <T> IResultSet<K, T> getResultSet(
- final IResultSetConfig<K> resultConfig, final IResultSetRetriever<T> dataRetriever)
+ final IResultSetConfig<K> resultConfig, final IOriginalDataProvider<T> dataRetriever)
{
assert resultConfig != null : "Unspecified result configuration";
assert dataRetriever != null : "Unspecified data retriever";
@@ -131,8 +131,8 @@ public final class CachedResultSetManager<K> implements IResultSetManager<K>, Se
if (dataKey == null)
{
operationLog.debug("Unknown result set key: retrieving the data.");
- dataKey = resultSetKeyProvider.getKey();
- data = dataRetriever.getData();
+ dataKey = resultSetKeyProvider.createKey();
+ data = dataRetriever.getOriginalData();
results.put(dataKey, data);
} else
{
@@ -169,7 +169,7 @@ public final class CachedResultSetManager<K> implements IResultSetManager<K>, Se
//
public final static class TokenBasedResultSetKeyProvider implements
- IResultSetKeyProvider<String>
+ IResultSetKeyGenerator<String>
{
private final TokenGenerator tokenGenerator;
@@ -183,14 +183,14 @@ public final class CachedResultSetManager<K> implements IResultSetManager<K>, Se
// IResultSetKeyProvider
//
- public final String getKey()
+ public final String createKey()
{
return tokenGenerator.getNewToken(System.currentTimeMillis());
}
}
public final static class CounterBasedResultSetKeyProvider implements
- IResultSetKeyProvider<Integer>
+ IResultSetKeyGenerator<Integer>
{
private int counter;
@@ -202,7 +202,7 @@ public final class CachedResultSetManager<K> implements IResultSetManager<K>, Se
// IResultSetKeyProvider
//
- public final Integer getKey()
+ public final Integer createKey()
{
return counter++;
}
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/IResultSetRetriever.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/IOriginalDataProvider.java
similarity index 80%
rename from openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/IResultSetRetriever.java
rename to openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/IOriginalDataProvider.java
index 57c25cc1f7c..e9dc5a9d0e4 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/IResultSetRetriever.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/IOriginalDataProvider.java
@@ -21,15 +21,15 @@ import java.util.List;
import ch.systemsx.cisd.common.exceptions.UserFailureException;
/**
- * Each implementation knows how to retrieve the data used to produce a {@link IResultSet}.
+ * Each implementation knows how to retrieve the original data used to produce a {@link IResultSet}.
*
* @author Christian Ribeaud
*/
-public interface IResultSetRetriever<T>
+public interface IOriginalDataProvider<T>
{
/**
* Returns the original data.
*/
- public List<T> getData() throws UserFailureException;
+ public List<T> getOriginalData() throws UserFailureException;
}
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/IResultSetKeyProvider.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/IResultSetKeyGenerator.java
similarity index 77%
rename from openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/IResultSetKeyProvider.java
rename to openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/IResultSetKeyGenerator.java
index 09023b20753..b91c90d7837 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/IResultSetKeyProvider.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/IResultSetKeyGenerator.java
@@ -17,15 +17,18 @@
package ch.systemsx.cisd.openbis.generic.client.web.server.resultset;
/**
- * A result set key provider.
+ * A result set key generator.
*
* @author Christian Ribeaud
*/
-public interface IResultSetKeyProvider<T>
+public interface IResultSetKeyGenerator<T>
{
/**
- * Returns an unique key.
+ * Creates and returns an unique result set key.
+ * <p>
+ * Each call will return a new value.
+ * </p>
*/
- public T getKey();
+ public T createKey();
}
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/IResultSetManager.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/IResultSetManager.java
index 2f7ebd684d5..76826a315e2 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/IResultSetManager.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/IResultSetManager.java
@@ -31,12 +31,12 @@ public interface IResultSetManager<K>
* Produces a {@link IResultSet} from given <var>resultConfig</var> and given
* <var>dataRetriever</var>.
* <p>
- * In case of cached data, the {@link IResultSetRetriever} implementation is only used in the
+ * In case of cached data, the {@link IOriginalDataProvider} implementation is only used in the
* first call, when the full data are not already there.
* </p>
*/
public <T> IResultSet<K, T> getResultSet(final IResultSetConfig<K> resultConfig,
- final IResultSetRetriever<T> dataRetriever) throws UserFailureException;
+ final IOriginalDataProvider<T> dataRetriever) throws UserFailureException;
/**
* Remove the data mapped to given <var>resultSetKey</var>.
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/plugin/generic/client/web/server/GenericClientService.java b/openbis/source/java/ch/systemsx/cisd/openbis/plugin/generic/client/web/server/GenericClientService.java
index 3d2dfe4565e..bc181b56c13 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/plugin/generic/client/web/server/GenericClientService.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/plugin/generic/client/web/server/GenericClientService.java
@@ -43,7 +43,7 @@ import ch.systemsx.cisd.openbis.generic.client.web.client.dto.SampleType;
import ch.systemsx.cisd.openbis.generic.client.web.client.dto.SearchableEntity;
import ch.systemsx.cisd.openbis.generic.client.web.server.resultset.IResultSet;
import ch.systemsx.cisd.openbis.generic.client.web.server.resultset.IResultSetManager;
-import ch.systemsx.cisd.openbis.generic.client.web.server.resultset.IResultSetRetriever;
+import ch.systemsx.cisd.openbis.generic.client.web.server.resultset.IOriginalDataProvider;
import ch.systemsx.cisd.openbis.generic.client.web.server.util.DtoConverters;
import ch.systemsx.cisd.openbis.generic.client.web.server.util.GroupTranslator;
import ch.systemsx.cisd.openbis.generic.client.web.server.util.ListSampleCriteriaTranslator;
@@ -281,14 +281,14 @@ public final class GenericClientService extends AbstractClientService implements
ListSampleCriteriaTranslator.translate(listCriteria);
final IResultSetManager<String> resultSetManager = getResultSetManager();
final IResultSet<String, Sample> result =
- resultSetManager.getResultSet(listCriteria, new IResultSetRetriever<Sample>()
+ resultSetManager.getResultSet(listCriteria, new IOriginalDataProvider<Sample>()
{
//
// IDataRetriever
//
- public final List<Sample> getData()
+ public final List<Sample> getOriginalData()
{
final List<SamplePE> samplePEs =
genericServer.listSamples(getSessionToken(), criteria);
@@ -367,14 +367,14 @@ public final class GenericClientService extends AbstractClientService implements
final IResultSetManager<String> resultSetManager = getResultSetManager();
final IResultSet<String, MatchingEntity> result =
resultSetManager.getResultSet(resultSetConfig,
- new IResultSetRetriever<MatchingEntity>()
+ new IOriginalDataProvider<MatchingEntity>()
{
//
// IDataRetriever
//
- public final List<MatchingEntity> getData()
+ public final List<MatchingEntity> getOriginalData()
{
return BeanUtils.createBeanList(MatchingEntity.class,
genericServer.listMatchingEntities(
diff --git a/openbis/sourceTest/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/CachedResultSetManagerTest.java b/openbis/sourceTest/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/CachedResultSetManagerTest.java
index 2164e2b0b2e..f9322aea7fc 100644
--- a/openbis/sourceTest/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/CachedResultSetManagerTest.java
+++ b/openbis/sourceTest/java/ch/systemsx/cisd/openbis/generic/client/web/server/resultset/CachedResultSetManagerTest.java
@@ -47,7 +47,7 @@ public final class CachedResultSetManagerTest
{
private IResultSetConfig<String> resultSetConfig;
- private IResultSetRetriever<?> resultSetRetriever;
+ private IOriginalDataProvider<?> resultSetRetriever;
private IResultSetManager<String> resultSetManager;
@@ -88,7 +88,7 @@ public final class CachedResultSetManagerTest
{
context = new Mockery();
resultSetConfig = context.mock(IResultSetConfig.class);
- resultSetRetriever = context.mock(IResultSetRetriever.class);
+ resultSetRetriever = context.mock(IOriginalDataProvider.class);
resultSetManager = createResultSetManager();
}
@@ -157,7 +157,7 @@ public final class CachedResultSetManagerTest
one(resultSetConfig).getResultSetKey();
will(returnValue(null));
- one(resultSetRetriever).getData();
+ one(resultSetRetriever).getOriginalData();
will(returnValue(Collections.emptyList()));
allowResultSetCreation(this);
--
GitLab