001: /***************************************************************
002: * This file is part of the [fleXive](R) project.
003: *
004: * Copyright (c) 1999-2008
005: * UCS - unique computing solutions gmbh (http://www.ucs.at)
006: * All rights reserved
007: *
008: * The [fleXive](R) project is free software; you can redistribute
009: * it and/or modify it under the terms of the GNU General Public
010: * License as published by the Free Software Foundation;
011: * either version 2 of the License, or (at your option) any
012: * later version.
013: *
014: * The GNU General Public License can be found at
015: * http://www.gnu.org/copyleft/gpl.html.
016: * A copy is found in the textfile GPL.txt and important notices to the
017: * license from the author are found in LICENSE.txt distributed with
018: * these libraries.
019: *
020: * This library is distributed in the hope that it will be useful,
021: * but WITHOUT ANY WARRANTY; without even the implied warranty of
022: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
023: * GNU General Public License for more details.
024: *
025: * For further information about UCS - unique computing solutions gmbh,
026: * please see the company website: http://www.ucs.at
027: *
028: * For further information about [fleXive](R), please see the
029: * project website: http://www.flexive.org
030: *
031: *
032: * This copyright notice MUST APPEAR in all copies of the file!
033: ***************************************************************/package com.flexive.shared.configuration.parameters;
034:
035: import com.flexive.shared.FxXMLUtils;
036: import com.flexive.shared.configuration.*;
037: import com.flexive.shared.content.FxPK;
038: import com.flexive.shared.search.*;
039: import com.flexive.shared.search.query.AssignmentValueNode;
040: import com.flexive.shared.search.query.QueryOperatorNode;
041: import com.flexive.shared.search.query.QueryRootNode;
042: import com.thoughtworks.xstream.XStream;
043:
044: /**
045: * Generic Object parameter wrapper. Takes any java object, serializes
046: * it to XML (currently using XStream), and stores it in the configuration.
047: *
048: *
049: * @author Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
050: * @param <T> type of the object stored in the parameter
051: */
052: public class ObjectParameter<T> extends
053: ParameterImpl<T, ObjectParameter<T>> {
054: private static final long serialVersionUID = -1843420825643455601L;
055:
056: // global parameters
057:
058: // per-division parameters
059:
060: // per-user configuration parameters
061:
062: public static final Parameter<FxPK> TEST_OBJ = ParameterFactory
063: .newInstance(FxPK.class, new ParameterDataEditBean<FxPK>(
064: SystemParameterPaths.GLOBAL_CONFIG,
065: "cactus.test.obj", new FxPK(0, 0)));
066:
067: private Class<T> cls; // the value object's class
068: private transient XStream instanceStream; // overrides default static xstream instance
069:
070: /** xstream instance used for serializing all parameters - aliases added in static constructor */
071: private static XStream xStream;
072:
073: static {
074: xStream = new XStream();
075:
076: // query node classes aliases
077: xStream.alias("queryOperatorNode", QueryOperatorNode.class);
078: xStream.alias("queryRootNode", QueryRootNode.class);
079: xStream.alias("propertyValueNode", AssignmentValueNode.class);
080:
081: // result preferences class
082: xStream.alias("resultPreferences", ResultPreferences.class);
083: // no distinction between immutable and editable objects for stored values
084: xStream.alias("resultPreferences", ResultPreferencesEdit.class);
085: xStream.alias("rpColumnInfo", ResultColumnInfo.class);
086: xStream.alias("rpOrderByInfo", ResultOrderByInfo.class);
087: xStream.alias("rpOrderByDirection", SortDirection.class);
088: }
089:
090: /**
091: * Creates a new object parameter definition.
092: * @param parameter parameter data
093: * @param cls the object's class
094: * @param registerParameter if the parameter should be registered in the static parameter table
095: * (don't do this for non-static parameter declarations)
096: */
097: public ObjectParameter(ParameterData<T> parameter, Class<T> cls,
098: boolean registerParameter) {
099: super (parameter, registerParameter);
100: this .cls = cls;
101: }
102:
103: /**
104: * Creates a new object parameter definition.
105: * @param parameter parameter data
106: * @param cls the object's class
107: * @param xStream xStream instance to be used for loading and storing values for this parameter.
108: * If null, the default xStream instance stored in this class will be used.
109: * @param registerParameter if the parameter should be registered in the static parameter table
110: * (don't do this for non-static parameter declarations)
111: */
112: public ObjectParameter(ParameterData<T> parameter, Class<T> cls,
113: boolean registerParameter, XStream xStream) {
114: super (parameter, registerParameter);
115: this .cls = cls;
116: this .instanceStream = xStream;
117: }
118:
119: /** {@inheritDoc} */
120: public Parameter<T> copy() {
121: return new ObjectParameter<T>(getData(), cls, false,
122: instanceStream);
123: }
124:
125: protected ObjectParameter<T> create(ParameterData<T> parameterData,
126: boolean registerParameter) {
127: return new ObjectParameter<T>(parameterData, cls,
128: registerParameter);
129: }
130:
131: /** {@inheritDoc} */
132: public T getValue(Object dbValue) {
133: return dbValue != null ? cls.cast(cls.isAssignableFrom(dbValue
134: .getClass()) ? dbValue : getXStream().fromXML(
135: dbValue.toString())) : null;
136: }
137:
138: /** {@inheritDoc} */
139: @Override
140: public String getDatabaseValue(T value) {
141: // add a bit of type safety here
142: if (!cls.isAssignableFrom(value.getClass())) {
143: throw new ClassCastException(
144: "Invalid class for configuration parameter ("
145: + value.getClass() + ", expected: " + cls
146: + ")");
147: }
148: return FxXMLUtils.toXML(getXStream(), value);
149: }
150:
151: /** {@inheritDoc} */
152: @Override
153: public boolean isValid(T value) {
154: return value != null;
155: }
156:
157: private XStream getXStream() {
158: return instanceStream != null ? instanceStream : xStream;
159: }
160:
161: public static XStream getDefaultXStream() {
162: return xStream;
163: }
164: }
|