You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuscany.apache.org by js...@apache.org on 2006/02/22 20:08:39 UTC

svn commit: r379845 - in /incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util: ModelContentHandler.java ModelTransformer.java ModelTransformerImpl.java

Author: jsdelfino
Date: Wed Feb 22 11:08:37 2006
New Revision: 379845

URL: http://svn.apache.org/viewcvs?rev=379845&view=rev
Log:
added model transformation utilities

Added:
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelContentHandler.java   (with props)
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelTransformer.java   (with props)
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelTransformerImpl.java   (with props)

Added: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelContentHandler.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelContentHandler.java?rev=379845&view=auto
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelContentHandler.java (added)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelContentHandler.java Wed Feb 22 11:08:37 2006
@@ -0,0 +1,71 @@
+/**
+ *
+ *  Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+package org.apache.tuscany.model.util;
+
+import java.util.List;
+import java.util.Map;
+
+/**
+ * A model content handler. This mimics a SAX content handler for models and
+ * receives notification of the content of a model. A model content handler is
+ * responsible for handling model content notifications. As part of the handling
+ * the handler can produce new contents.
+ */
+public interface ModelContentHandler {
+
+	/**
+	 * Starts handling of a model.
+	 */
+	public void startModel();
+
+	/**
+	 * Ends handling of a model.
+	 */
+	public void endModel();
+
+	/**
+	 * Sets the contents list, where the content handler should store
+	 * the contents that it produces.
+	 * @param contents The contents to set
+	 */
+	public void setContents(List contents);
+
+	/**
+	 * Sets the linkers list. A content handler can add linker objects to this
+	 * list. Linker objects must implement java.lang.Runnable. They are
+	 * run as part of the endModel notification processing.
+	 * Typically linker objects are used to resolve model forward references
+	 * or establish model relationships after the model content has been
+	 * handled.
+	 * @param linkers The linkers to set
+	 */
+	public void setLinkers(List linkers);
+
+	/**
+	 * Sets the targets map. This map keeps track of the objects returned by
+	 * the content handler for each object passed to its doSwitch method.
+	 * @param targets The targets to set
+	 */
+	public void setTargets(Map targets);
+
+	/**
+	 * This method dispatches handling of the given object (XYZ for example) to a
+	  * corresponding "caseXYZ()" method on the content handler.
+	 */
+	public Object doSwitch(Object object);
+
+}

Propchange: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelContentHandler.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelContentHandler.java
------------------------------------------------------------------------------
    svn:keywords = Rev,Date

Added: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelTransformer.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelTransformer.java?rev=379845&view=auto
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelTransformer.java (added)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelTransformer.java Wed Feb 22 11:08:37 2006
@@ -0,0 +1,51 @@
+/**
+ *
+ *  Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+package org.apache.tuscany.model.util;
+
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * A model transformer. Invokes a model content handler to perform the actual transformation.
+ */
+public interface ModelTransformer {
+
+    /**
+	 * Uses a ModelContentHandler to transform a model.
+	 */
+	public List transform(Iterator iterator, ModelContentHandler handler);
+
+	/**
+	 * Uses a ModelContentHandler to transform a model. Performs the first
+	 * transform pass.
+	 */
+	public List transformPass1(Iterator iterator, ModelContentHandler handler, List deferredHandlers);
+
+	/**
+	 * Uses a ModelContentHandler to transform a model. Performs the first
+	 * transform pass.
+	 */
+	public List transformPass1(Iterator iterator, final ModelContentHandler handler, List deferredHandlers, Map targets, List contents);
+
+	/**
+	 * Uses a ModelContentHandler to transform a model. Performs the second
+	 * transform pass.
+	 */
+	public void transformPass2(List deferredHandlers);
+
+}

Propchange: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelTransformer.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelTransformer.java
------------------------------------------------------------------------------
    svn:keywords = Rev,Date

Added: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelTransformerImpl.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelTransformerImpl.java?rev=379845&view=auto
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelTransformerImpl.java (added)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelTransformerImpl.java Wed Feb 22 11:08:37 2006
@@ -0,0 +1,123 @@
+/**
+ *
+ *  Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+package org.apache.tuscany.model.util;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+
+
+/**
+ * @author jsdelfino
+ *
+ * Base implementation for a model transformer.
+ * Invokes a model content handler to perform the actual transformation.
+ */
+public class ModelTransformerImpl implements ModelTransformer {
+
+	/**
+	 * Uses a ModelContentHandler to transform a model.
+	 */
+	public List transform(Iterator iterator, ModelContentHandler handler) {
+
+		// Pass 1: visit the source model and create target model objects
+		List linkers=new ArrayList();
+		List contents=transformPass1(iterator, handler, linkers);
+
+		// Pass 2: resolve the links between the target model objects
+		transformPass2(linkers);
+
+		// Return the target model contents
+		return contents;
+	}
+
+	/**
+	 * Uses a ModelContentHandler to transform a model.
+	 */
+	public List transformPass1(Iterator iterator, final ModelContentHandler handler, List deferredHandlers, Map targets, List contents) {
+
+		// Initialize the handler
+		handler.setTargets(targets);
+		handler.setLinkers(deferredHandlers);
+		handler.setContents(contents);
+
+		// This runnable will invoke endModel and clean up the handler
+		Runnable cleanup=new Runnable() {
+			public void run() {
+
+				// Cleanup
+				handler.endModel();
+
+				handler.setTargets(null);
+				handler.setLinkers(null);
+				handler.setContents(null);
+			}
+		};
+
+		// Run the handler
+		try {
+			handler.startModel();
+
+			// Pass 1: compile, visit the source model and create target model objects
+			for (; iterator.hasNext(); ) {
+				Object source=iterator.next();
+				Object target=handler.doSwitch(source);
+
+				// Record source to target associations
+				targets.put(source,target);
+			}
+
+			// Add the cleanup runnable
+			deferredHandlers.add(cleanup);
+
+		} catch (Exception e) {
+
+			// An exception occurred, run the cleanup now
+			cleanup.run();
+			throw new RuntimeException(e);
+		}
+
+		// return the target model contents
+		// note that this list may actually be populated in pass2
+		return contents;
+	}
+
+	/**
+	 * Uses a ModelContentHandler to transform a model.
+	 */
+	public List transformPass1(Iterator iterator, final ModelContentHandler handler, List deferredHandlers) {
+		Map targets=new HashMap();
+		List contents=new ArrayList();
+		return transformPass1(iterator,handler,deferredHandlers,targets,contents);
+	}
+
+	/**
+	 * Uses a ModelContentHandler to transform a model.
+	 */
+	public void transformPass2(List deferredHandlers) {
+
+		// Pass 2: link, resolve the links between the target model objects
+		for (Iterator i=deferredHandlers.iterator(); i.hasNext(); ) {
+			Runnable runnable=(Runnable)i.next();
+			runnable.run();
+		}
+
+	}
+
+}

Propchange: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelTransformerImpl.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/util/ModelTransformerImpl.java
------------------------------------------------------------------------------
    svn:keywords = Rev,Date