Repackage to org.cristalise

5 files changed, 444 insertions, 0 deletions

diff --git a/src/main/java/org/cristalise/kernel/property/Property.java b/src/main/java/org/cristalise/kernel/property/Property.java
new file mode 100644
index 0000000..920574c
--- /dev/null
+++ b/src/main/java/org/cristalise/kernel/property/Property.java
@@ -0,0 +1,112 @@
+/**

+ * This file is part of the CRISTAL-iSE kernel.

+ * Copyright (c) 2001-2014 The CRISTAL Consortium. All rights reserved.

+ *

+ * This library is free software; you can redistribute it and/or modify it

+ * under the terms of the GNU Lesser General Public License as published

+ * by the Free Software Foundation; either version 3 of the License, or (at

+ * your option) any later version.

+ *

+ * This library is distributed in the hope that it will be useful, but WITHOUT

+ * ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or

+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public

+ * License for more details.

+ *

+ * You should have received a copy of the GNU Lesser General Public License

+ * along with this library; if not, write to the Free Software Foundation,

+ * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.

+ *

+ * http://www.fsf.org/licensing/licenses/lgpl.html

+ */

+package org.cristalise.kernel.property;

+

+import org.cristalise.kernel.entity.C2KLocalObject;

+import org.cristalise.kernel.persistency.ClusterStorage;

+

+

+public class Property implements C2KLocalObject

+{

+    private String  mName;

+    private String  mValue;

+    private boolean mMutable = true;

+

+

+   /**************************************************************************

+    *

+    **************************************************************************/

+    public Property()

+    {

+    }

+

+

+   /**************************************************************************

+    *

+    **************************************************************************/

+    public Property( String name, String value, boolean mutable )

+    {

+        setName( name );

+        setValue( value );

+        setMutable( mutable );

+    }

+    

+    public Property( String name, String value)

+    {

+        setName( name );

+        setValue( value );

+    }

+

+   /**************************************************************************

+    *

+    **************************************************************************/

+    @Override

+	public void setName(String name)

+    {

+        mName = name;

+    }

+

+

+   public boolean isMutable() {

+	   return mMutable;

+   }

+

+

+   public void setMutable(boolean mMutable) {

+	   this.mMutable = mMutable;

+   }

+

+

+/**************************************************************************

+    *

+    **************************************************************************/

+    @Override

+	public String getName()

+    {

+        return mName;

+    }

+

+

+   /**************************************************************************

+    *

+    **************************************************************************/

+    public void setValue( String value )

+    {

+        mValue = value;

+    }

+

+

+   /**************************************************************************

+    *

+    **************************************************************************/

+    public String getValue()

+    {

+        return mValue;

+    }

+	/**

+	 * @see org.cristalise.kernel.entity.C2KLocalObject#getClusterType()

+	 */

+	@Override

+	public String getClusterType() {

+		return ClusterStorage.PROPERTY;

+	}

+

+}

diff --git a/src/main/java/org/cristalise/kernel/property/PropertyArrayList.java b/src/main/java/org/cristalise/kernel/property/PropertyArrayList.java
new file mode 100644
index 0000000..3e981a0
--- /dev/null
+++ b/src/main/java/org/cristalise/kernel/property/PropertyArrayList.java
@@ -0,0 +1,54 @@
+/**

+ * This file is part of the CRISTAL-iSE kernel.

+ * Copyright (c) 2001-2014 The CRISTAL Consortium. All rights reserved.

+ *

+ * This library is free software; you can redistribute it and/or modify it

+ * under the terms of the GNU Lesser General Public License as published

+ * by the Free Software Foundation; either version 3 of the License, or (at

+ * your option) any later version.

+ *

+ * This library is distributed in the hope that it will be useful, but WITHOUT

+ * ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or

+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public

+ * License for more details.

+ *

+ * You should have received a copy of the GNU Lesser General Public License

+ * along with this library; if not, write to the Free Software Foundation,

+ * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.

+ *

+ * http://www.fsf.org/licensing/licenses/lgpl.html

+ */

+package org.cristalise.kernel.property;

+

+import java.util.ArrayList;

+

+import org.cristalise.kernel.utils.CastorArrayList;

+

+

+public class PropertyArrayList extends CastorArrayList<Property>

+{

+    public PropertyArrayList()

+    {

+        super();

+    }

+

+    public PropertyArrayList(ArrayList<Property> aList)

+    {

+        super();

+        // put all properties in order, so later ones with the same name overwrite earlier ones

+        for (Property property : aList) {

+			put(property);

+		}

+    }

+

+    /** Overwrite */

+    public void put(Property p) {

+    	for (Property thisProp : list) {

+			if (thisProp.getName().equals(p.getName())) {

+				list.remove(thisProp);

+				break;

+			}

+		}

+		list.add(p);

+    }

+}

diff --git a/src/main/java/org/cristalise/kernel/property/PropertyDescription.java b/src/main/java/org/cristalise/kernel/property/PropertyDescription.java
new file mode 100644
index 0000000..29b10b1
--- /dev/null
+++ b/src/main/java/org/cristalise/kernel/property/PropertyDescription.java
@@ -0,0 +1,88 @@
+/**

+ * This file is part of the CRISTAL-iSE kernel.

+ * Copyright (c) 2001-2014 The CRISTAL Consortium. All rights reserved.

+ *

+ * This library is free software; you can redistribute it and/or modify it

+ * under the terms of the GNU Lesser General Public License as published

+ * by the Free Software Foundation; either version 3 of the License, or (at

+ * your option) any later version.

+ *

+ * This library is distributed in the hope that it will be useful, but WITHOUT

+ * ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or

+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public

+ * License for more details.

+ *

+ * You should have received a copy of the GNU Lesser General Public License

+ * along with this library; if not, write to the Free Software Foundation,

+ * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.

+ *

+ * http://www.fsf.org/licensing/licenses/lgpl.html

+ */

+package org.cristalise.kernel.property;

+

+public class PropertyDescription

+{

+    private String mName=null;

+	private String mDefaultValue=null;

+	private boolean mIsClassIdentifier=false;

+	private boolean mIsMutable=false;

+

+

+    public PropertyDescription()

+    {

+    }

+

+    public PropertyDescription(String name, String defaultValue, boolean isClassIdentifier, boolean isMutable )

+    {

+    	setName(name);

+    	setDefaultValue(defaultValue);

+    	setIsClassIdentifier(isClassIdentifier);

+    	setIsMutable(isMutable);

+    }

+

+	public void setName(String name)

+	{

+		mName = name;

+	}

+

+	public void setIsClassIdentifier(boolean classId)

+	{

+		mIsClassIdentifier = classId;

+	}

+

+	public void setDefaultValue(String defaultValue)

+	{

+		mDefaultValue = defaultValue;

+	}

+

+	public void setIsMutable(boolean mutable)

+	{

+		mIsMutable = mutable;

+	}

+

+	public String getName()

+	{

+		return mName;

+	}

+

+	public boolean getIsClassIdentifier()

+	{

+		return mIsClassIdentifier;

+	}

+

+	public String getDefaultValue()

+	{

+		return mDefaultValue;

+	}

+

+	public boolean getIsMutable()

+	{

+		return mIsMutable;

+	}

+

+	public Property getProperty()

+	{

+		return new Property(mName, mDefaultValue, mIsMutable);

+	}

+

+}

diff --git a/src/main/java/org/cristalise/kernel/property/PropertyDescriptionList.java b/src/main/java/org/cristalise/kernel/property/PropertyDescriptionList.java
new file mode 100644
index 0000000..98df773
--- /dev/null
+++ b/src/main/java/org/cristalise/kernel/property/PropertyDescriptionList.java
@@ -0,0 +1,94 @@
+/**

+ * This file is part of the CRISTAL-iSE kernel.

+ * Copyright (c) 2001-2014 The CRISTAL Consortium. All rights reserved.

+ *

+ * This library is free software; you can redistribute it and/or modify it

+ * under the terms of the GNU Lesser General Public License as published

+ * by the Free Software Foundation; either version 3 of the License, or (at

+ * your option) any later version.

+ *

+ * This library is distributed in the hope that it will be useful, but WITHOUT

+ * ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or

+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public

+ * License for more details.

+ *

+ * You should have received a copy of the GNU Lesser General Public License

+ * along with this library; if not, write to the Free Software Foundation,

+ * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.

+ *

+ * http://www.fsf.org/licensing/licenses/lgpl.html

+ */

+package org.cristalise.kernel.property;

+

+import java.util.ArrayList;

+import java.util.HashMap;

+

+import org.cristalise.kernel.common.InvalidDataException;

+import org.cristalise.kernel.utils.CastorArrayList;

+

+

+public class PropertyDescriptionList extends CastorArrayList<PropertyDescription>

+{

+    public PropertyDescriptionList()

+    {

+        super();

+    }

+

+    public PropertyDescriptionList(ArrayList<PropertyDescription> aList)

+    {

+        super(aList);

+    }

+

+    public String getClassProps() {

+        StringBuffer props = new StringBuffer();

+        for (PropertyDescription element : list) {

+            if (element.getIsClassIdentifier()) {

+                if (props.length()>0)

+                    props.append(",");

+                props.append(element.getName());

+            }

+        }

+        return props.toString();

+    }

+

+    public boolean setDefaultValue(String name, String value) {

+        for (PropertyDescription element : list) {

+            if (element.getName().equals(name)) {

+                element.setDefaultValue(value);

+                return true;

+            }

+        }

+        return false;

+    }

+    

+    public boolean definesProperty(String name) {

+    	for (PropertyDescription element : list) {

+    		if (element.getName().equals(name))

+    			return true;

+    	}

+    	return false;

+    }

+    

+    public PropertyArrayList instantiate(PropertyArrayList initProps) throws InvalidDataException {

+    	// check that supplied init properties exist in desc list

+    	HashMap<String, String> validatedInitProps = new HashMap<String, String>();

+    	for (Property initProp : initProps.list) {

+    		if (!definesProperty(initProp.getName()))

+    			throw new InvalidDataException("Property "+initProp.getName()+" has not been declared in the property descriptions");

+    		else

+    			validatedInitProps.put(initProp.getName(), initProp.getValue());

+		}

+    	

+    	PropertyArrayList propInst = new PropertyArrayList();

+        for (int i = 0; i < list.size(); i++) {

+        	PropertyDescription pd = list.get(i);

+        	String propName = pd.getName();

+        	String propVal = pd.getDefaultValue();

+        	if (validatedInitProps.containsKey(propName))

+        		propVal = validatedInitProps.get(propName);

+        	boolean isMutable = pd.getIsMutable();

+        	propInst.list.add( new Property(propName, propVal, isMutable));

+        }

+        return propInst;

+    }

+}

diff --git a/src/main/java/org/cristalise/kernel/property/PropertyUtility.java b/src/main/java/org/cristalise/kernel/property/PropertyUtility.java
new file mode 100644
index 0000000..39d399f
--- /dev/null
+++ b/src/main/java/org/cristalise/kernel/property/PropertyUtility.java
@@ -0,0 +1,96 @@
+/**

+ * This file is part of the CRISTAL-iSE kernel.

+ * Copyright (c) 2001-2014 The CRISTAL Consortium. All rights reserved.

+ *

+ * This library is free software; you can redistribute it and/or modify it

+ * under the terms of the GNU Lesser General Public License as published

+ * by the Free Software Foundation; either version 3 of the License, or (at

+ * your option) any later version.

+ *

+ * This library is distributed in the hope that it will be useful, but WITHOUT

+ * ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or

+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public

+ * License for more details.

+ *

+ * You should have received a copy of the GNU Lesser General Public License

+ * along with this library; if not, write to the Free Software Foundation,

+ * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.

+ *

+ * http://www.fsf.org/licensing/licenses/lgpl.html

+ */

+package org.cristalise.kernel.property;

+

+import java.util.ArrayList;

+import java.util.Iterator;

+

+import org.cristalise.kernel.common.ObjectNotFoundException;

+import org.cristalise.kernel.lookup.ItemPath;

+import org.cristalise.kernel.persistency.ClusterStorage;

+import org.cristalise.kernel.persistency.outcome.Outcome;

+import org.cristalise.kernel.process.Gateway;

+import org.cristalise.kernel.utils.CastorHashMap;

+import org.cristalise.kernel.utils.Logger;

+

+

+

+public class PropertyUtility

+{

+    static public String getValue(ArrayList<PropertyDescription> pdlist, String name)

+	{

+		for (PropertyDescription pd : pdlist) {

+			if ( name.equalsIgnoreCase(pd.getName()) )

+				return pd.getDefaultValue();

+		}

+		return null;

+	}

+

+	static public String getNames(ArrayList<PropertyDescription> pdlist)

+	{

+		StringBuffer names = new StringBuffer();

+		for (PropertyDescription value : pdlist)

+			names.append( value.getDefaultValue()).append(" ");

+		return names.toString();

+	}

+

+	static public String getClassIdNames(ArrayList<PropertyDescription> pdlist)

+	{

+		StringBuffer names = new StringBuffer();

+		

+		for (Iterator<PropertyDescription> iter = pdlist.iterator(); iter.hasNext();) {

+			PropertyDescription pd = iter.next();

+			if (pd.getIsClassIdentifier())

+				names.append(pd.getName());

+			if (iter.hasNext())

+				names.append(",");

+		}

+		return names.toString();

+	}

+

+

+	static public PropertyDescriptionList getPropertyDescriptionOutcome(ItemPath itemPath, String descVer) throws ObjectNotFoundException

+	{

+        try

+        {

+            Outcome outc = (Outcome) Gateway.getStorage().get(itemPath, ClusterStorage.VIEWPOINT+"/PropertyDescription/"+descVer+"/data", null);

+			return (PropertyDescriptionList)Gateway.getMarshaller().unmarshall(outc.getData());

+        }

+        catch (Exception ex)

+        {

+        	Logger.error(ex);

+        	throw new ObjectNotFoundException("Could not fetch PropertyDescription from "+itemPath);

+        }

+	}

+

+	static public CastorHashMap createProperty(PropertyDescriptionList pdList)

+	{

+		CastorHashMap props = new CastorHashMap();

+		for (int i=0; i< pdList.list.size();i++)

+		{

+			PropertyDescription pd = pdList.list.get(i);

+			if (pd.getIsClassIdentifier())

+				props.put(pd.getName(),pd.getDefaultValue());

+		}

+		return props;

+	}

+

+}