1 package com.indexdata.pz2utils4jsf.pazpar2.state;
\r
3 import java.io.Serializable;
\r
4 import java.util.ArrayList;
\r
5 import java.util.Arrays;
\r
6 import java.util.HashMap;
\r
7 import java.util.List;
\r
8 import java.util.Map;
\r
10 import javax.enterprise.context.SessionScoped;
\r
12 import org.apache.log4j.Logger;
\r
14 import com.indexdata.pz2utils4jsf.pazpar2.commands.CommandReadOnly;
\r
15 import com.indexdata.pz2utils4jsf.pazpar2.commands.Pazpar2Command;
\r
16 import com.indexdata.pz2utils4jsf.utils.Utils;
\r
19 public class StateManager implements Serializable {
\r
21 private static final long serialVersionUID = 8152558351351730035L;
\r
23 Map<String, Pazpar2State> states = new HashMap<String, Pazpar2State>();
\r
24 String currentKey = "";
\r
25 private static List<String> allCommands = new ArrayList<String>(Arrays.asList("init","ping","settings","search","stat","show","record","termlist","bytarget"));
\r
26 Map<String,Boolean> pendingStateChanges = new HashMap<String,Boolean>();
\r
27 private static Logger logger = Logger.getLogger(StateManager.class);
\r
28 private List<StateListener> listeners = new ArrayList<StateListener>();
\r
30 public StateManager () {
\r
31 logger.info("Initializing a Pazpar2 state manager [" + Utils.objectId(this) + "]");
\r
32 Pazpar2State initialState = new Pazpar2State(this);
\r
33 states.put(initialState.getKey(), initialState);
\r
34 currentKey = initialState.getKey();
\r
35 for (String command : allCommands) {
\r
36 pendingStateChanges.put(command, new Boolean(false));
\r
40 public void addStateListener(StateListener listener) {
\r
41 listeners.add(listener);
\r
44 public void removeStateListener (StateListener listener) {
\r
45 listeners.remove(listener);
\r
48 private void updateListeners (String command) {
\r
49 for (StateListener lsnr : listeners) {
\r
50 lsnr.stateUpdated(command);
\r
55 * Registers a Pazpar2 command for execution.
\r
57 * The state manager will update current state and flag that
\r
58 * a request change was made but that it was not yet carried
\r
59 * out against Pazpar2.
\r
61 * Any command that is created or modified must be checked in
\r
62 * like this to come into effect.
\r
66 public void checkIn(Pazpar2Command command) {
\r
67 if (getCurrentState().stateMutating(command)) {
\r
68 logger.debug("State changed by: " + command.getName());
\r
69 Pazpar2State state = new Pazpar2State(getCurrentState(),command);
\r
70 states.put(state.getKey(), state);
\r
71 currentKey = state.getKey();
\r
72 hasPendingStateChange(command.getName(),new Boolean(true));
\r
73 logger.debug("Updating " + listeners.size() + " listener(s) with state change from " + command);
\r
74 updateListeners(command.getName());
\r
76 logger.debug("Command " + command.getName() + " not found to change the state [" + command.getEncodedQueryString() + "]");
\r
81 * Gets a detached copy of a command. For the change manager
\r
82 * to become aware of any changes to the copy it must be
\r
83 * checked back in with 'checkIn(Pazpar2Command)'
\r
85 * @param commandName
\r
86 * @return Copy this state's instance of the given command
\r
88 public Pazpar2Command checkOut (String commandName) {
\r
89 logger.debug("Getting " + commandName + " from state manager.");
\r
90 return getCurrentState().getCommand(commandName).copy();
\r
93 public CommandReadOnly getCommand (String commandName) {
\r
94 return getCurrentState().getCommand(commandName);
\r
97 public Pazpar2State getCurrentState () {
\r
98 return states.get(currentKey);
\r
102 * Changes the current state key. Invoked from the UI to have the state
\r
103 * manager switch to another state than the current one.
\r
107 public void setCurrentStateKey(String key) {
\r
108 if (currentKey.equals(key)) {
\r
109 logger.debug("setCurrentStateKey: no key change detected");
\r
111 logger.debug("State key change. Was: [" + currentKey + "]. Will be ["+key+"]");
\r
112 if (states.get(key)==null) {
\r
113 logger.error("The back-end received an unknow state key.");
\r
115 if (states.get(key).getCommand("search").equals(states.get(currentKey).getCommand("search"))) {
\r
116 logger.debug("No search change detected");
\r
118 hasPendingStateChange("search",true);
\r
120 if (states.get(key).getCommand("record").equals(states.get(currentKey).getCommand("record"))) {
\r
121 logger.debug("No record change detected");
\r
123 hasPendingStateChange("record",true);
\r
131 * Sets a pending-state-change flag for the given command and notifies
\r
132 * registered listeners.
\r
134 * It is up to the listener to reset the flag as needed.
\r
139 public void hasPendingStateChange(String command, boolean bool) {
\r
140 pendingStateChanges.put(command, new Boolean(bool));
\r
146 * @return true if there is a non-executed command change in this state
\r
148 public boolean hasPendingStateChange (String command) {
\r
149 return pendingStateChanges.get(command).booleanValue();
\r