Mercurial > dive4elements > framework
diff artifact-database/src/main/java/org/dive4elements/artifactdatabase/AbstractCallContext.java @ 473:d0ac790a6c89 dive4elements-move
Moved directories to org.dive4elements
author | Sascha L. Teichmann <teichmann@intevation.de> |
---|---|
date | Thu, 25 Apr 2013 10:57:18 +0200 |
parents | artifact-database/src/main/java/de/intevation/artifactdatabase/AbstractCallContext.java@f367be55dd35 |
children | 415df0fc4fa1 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/artifact-database/src/main/java/org/dive4elements/artifactdatabase/AbstractCallContext.java Thu Apr 25 10:57:18 2013 +0200 @@ -0,0 +1,154 @@ +/* + * Copyright (c) 2010, 2011 by Intevation GmbH + * + * This program is free software under the LGPL (>=v2.1) + * Read the file LGPL.txt coming with the software for details + * or visit http://www.gnu.org/licenses/ if it does not exist. + */ +package de.intevation.artifactdatabase; + +import org.apache.log4j.Logger; + +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.HashMap; + +import de.intevation.artifacts.ArtifactDatabase; +import de.intevation.artifacts.CallContext; +import de.intevation.artifacts.CallMeta; +import de.intevation.artifacts.DataProvider; + + +/** + * Abstract class that implements some basic methods of a CallContext. + * + * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> + * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> + */ +public abstract class AbstractCallContext implements CallContext { + + Logger logger = Logger.getLogger(AbstractCallContext.class); + + /** + * The ArtifactDatabase instance. + */ + protected ArtifactDatabaseImpl database; + + /** + * The action to be performed after the artifacts or collections calls. + */ + protected int action; + + /** + * The meta information of the concrete call (preferred languages et. al.) + */ + protected CallMeta callMeta; + + /** + * Map to act like a clipboard when nesting calls like a proxy artifact. + */ + protected Map customValues; + + /** + * Map to act like a clipboard when nesting calls like a proxy artifact. + */ + protected Map<Object, List<DataProvider>> dataProviders; + + + /** + * The default constructor of this abstract CallContext. + * + * @param artifactDatabase The artifact database. + * @param action The action. + * @param callMeta The CallMeta object. + */ + public AbstractCallContext( + ArtifactDatabaseImpl artifactDatabase, + int action, + CallMeta callMeta + ) { + this.database = artifactDatabase; + this.action = action; + this.callMeta = callMeta; + + database.initCallContext(this); + } + + + public void postCall() { + database.closeCallContext(this); + } + + public abstract void afterCall(int action); + + public abstract Long getTimeToLive(); + + public abstract void afterBackground(int action); + + + public Object globalContext() { + return database.context; + } + + + public ArtifactDatabase getDatabase() { + return database; + } + + + public CallMeta getMeta() { + return callMeta; + } + + + public Object getContextValue(Object key) { + return customValues != null + ? customValues.get(key) + : null; + } + + public Object putContextValue(Object key, Object value) { + if (customValues == null) { + customValues = new HashMap(); + } + return customValues.put(key, value); + } + + /** + * Get list of DataProviders that registered for given key. + * @return list (empty list if none found, never null). + */ + public List<DataProvider> getDataProvider(Object key) { + if (dataProviders != null) { + List<DataProvider> list = dataProviders.get(key); + return list != null + ? list + : java.util.Collections.<DataProvider>emptyList(); + } + return java.util.Collections.<DataProvider>emptyList(); + } + + + /** + * Let a DataProvider register itself with given key. + * Multiple DataProvider can register under the same key. + */ + public Object registerDataProvider(Object key, DataProvider value) { + List<DataProvider> providers = null; + if (dataProviders == null) { + dataProviders = new HashMap(); + providers = new ArrayList<DataProvider>(); + providers.add(value); + return dataProviders.put(key, providers); + } + providers = dataProviders.get(key); + + if (providers == null) { + providers = new ArrayList<DataProvider>(); + } + providers.add(value); + return dataProviders.put(key, providers); + } +} +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :