You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuscany.apache.org by me...@apache.org on 2007/03/03 13:17:32 UTC

svn commit: r514137 - in /incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller: ./ java/

Author: meerajk
Date: Sat Mar  3 04:17:30 2007
New Revision: 514137

URL: http://svn.apache.org/viewvc?view=rev&rev=514137
Log:
Added Java doc.

Modified:
    incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/AbstractMarshallerExtension.java
    incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/java/JavaPhysicalComponentDefinitionMarshaller.java
    incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/java/JavaPhysicalReferenceDefinitionMarshaller.java
    incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/java/JavaPhysicalServiceDefinitionMarshaller.java

Modified: incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/AbstractMarshallerExtension.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/AbstractMarshallerExtension.java?view=diff&rev=514137&r1=514136&r2=514137
==============================================================================
--- incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/AbstractMarshallerExtension.java (original)
+++ incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/AbstractMarshallerExtension.java Sat Mar  3 04:17:30 2007
@@ -42,7 +42,7 @@
      * @param registry Model marshaller registry.
      */
     @Reference
-    public void setRegistry(ModelMarshallerRegistry registry) {
+    public final void setRegistry(ModelMarshallerRegistry registry) {
 
         this.registry = registry;
 

Modified: incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/java/JavaPhysicalComponentDefinitionMarshaller.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/java/JavaPhysicalComponentDefinitionMarshaller.java?view=diff&rev=514137&r1=514136&r2=514137
==============================================================================
--- incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/java/JavaPhysicalComponentDefinitionMarshaller.java (original)
+++ incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/java/JavaPhysicalComponentDefinitionMarshaller.java Sat Mar  3 04:17:30 2007
@@ -27,7 +27,7 @@
 import org.apache.tuscany.core.model.physical.java.JavaPhysicalComponentDefinition;
 
 /**
- * Marshaller for physical wire definition.
+ * Marshaller for Java physical component definitions.
  * 
  * @version $Revision$ $Date$
  */
@@ -38,10 +38,28 @@
 
     // QName for the root element
     private static final QName QNAME = new QName("http://tuscany.apache.org/xmlns/marshaller/component/java/1.0-SNAPSHOT", "component");
+
+    /**
+     * Gets the qualified name of the XML fragment for the marshalled model object.
+     * @return {"http://tuscany.apache.org/xmlns/marshaller/component/java/1.0-SNAPSHOT", "component"}
+     */
+    @Override
+    protected QName getModelObjectQName() {
+        return QNAME;
+    }
+
+    /**
+     * Retursn the type of the model object.
+     * @return <code>JavaPhysicalComponentDefinition.class</code>.
+     */
+    @Override
+    protected Class<JavaPhysicalComponentDefinition> getModelObjectType() {
+        return JavaPhysicalComponentDefinition.class;
+    }
     
     /**
      * Create the concrete PCD.
-     * @return Java physical component definition
+     * @return An instance of<code>JavaPhysicalComponentDefinition</code>.
      */
     @Override
     protected JavaPhysicalComponentDefinition getConcreteModelObject() {
@@ -49,7 +67,9 @@
     }
     
     /**
-     * Handles extensions for unmarshalling.
+     * Handles extensions for unmarshalling Java physical component definitions 
+     * including the marshalling of base64 encoded instance factory byte code.
+     * 
      * @param componentDefinition Physical component definition.
      * @param reader Reader from which marshalled data is read.
      */
@@ -64,30 +84,14 @@
     }
     
     /**
-     * Handles extensions for marshalling.
+     * Handles extensions for marshalling Java physical component definitions 
+     * including the marshalling of base64 encoded instance factory byte code.
+     * 
      * @param componentDefinition Physical component definition.
      * @param reader Writer to which marshalled data is written.
      */
     @Override
     protected void handleExtensions(JavaPhysicalComponentDefinition componentDefinition, XMLStreamWriter writer) {
-    }
-
-    /**
-     * Gets the qualified name of the XML fragment for the marshalled model object.
-     * @return Qualified name of the XML fragment.
-     */
-    @Override
-    protected QName getModelObjectQName() {
-        return QNAME;
-    }
-
-    /**
-     * Retursn the type of the model object.
-     * @return Model object type.
-     */
-    @Override
-    protected Class<JavaPhysicalComponentDefinition> getModelObjectType() {
-        return JavaPhysicalComponentDefinition.class;
     }
 
 }

Modified: incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/java/JavaPhysicalReferenceDefinitionMarshaller.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/java/JavaPhysicalReferenceDefinitionMarshaller.java?view=diff&rev=514137&r1=514136&r2=514137
==============================================================================
--- incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/java/JavaPhysicalReferenceDefinitionMarshaller.java (original)
+++ incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/java/JavaPhysicalReferenceDefinitionMarshaller.java Sat Mar  3 04:17:30 2007
@@ -33,11 +33,11 @@
 public class JavaPhysicalReferenceDefinitionMarshaller extends AbstractPhysicalReferenceDefinitionMarshaller<JavaPhysicalReferenceDefinition> {
     
     // QName for the root element
-    private static final QName QNAME = new QName("http://tuscany.apache.org/xmlns/marshaller/reference/java/1.0-SNAPSHOT", "service");
+    private static final QName QNAME = new QName("http://tuscany.apache.org/xmlns/marshaller/reference/java/1.0-SNAPSHOT", "reference");
 
     /**
      * Gets the qualified name of the XML fragment for the marshalled model object.
-     * @return Qualified name of the XML fragment.
+     * @return {"http://tuscany.apache.org/xmlns/marshaller/reference/java/1.0-SNAPSHOT", "service"}.
      */
     @Override
     protected QName getModelObjectQName() {
@@ -46,7 +46,7 @@
 
     /**
      * Retursn the type of the model object.
-     * @return Model object type.
+     * @return <code>JavaPhysicalReferenceDefinition.class</code>.
      */
     @Override
     protected Class<JavaPhysicalReferenceDefinition> getModelObjectType() {
@@ -55,7 +55,7 @@
 
     /**
      * Create the concrete model object.
-     * @return Concrete model object.
+     * @return An instance of <code>JavaPhysicalReferenceDefinition</code>.
      */
     @Override
     protected JavaPhysicalReferenceDefinition getConcreteModelObject() {
@@ -63,25 +63,21 @@
     }
 
     /**
-     * Handles extensions for unmarshalling.
+     * Handles extensions for unmarshalling Java physical references.
      * @param modelObject Concrete model object.
      * @param reader Reader from which marshalled data is read.
      */
     @Override
     protected void handleExtensions(JavaPhysicalReferenceDefinition modelObject, XMLStreamReader reader) {
-        // TODO Auto-generated method stub
-        
     }
 
     /**
-     * Handles extensions for marshalling.
+     * Handles extensions for marshalling Java physical references.
      * @param modelObject Concrete model object.
      * @param reader Writer to which marshalled data is written.
      */
     @Override
     protected void handleExtensions(JavaPhysicalReferenceDefinition modelObject, XMLStreamWriter writer) {
-        // TODO Auto-generated method stub
-        
     }
 
 }

Modified: incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/java/JavaPhysicalServiceDefinitionMarshaller.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/java/JavaPhysicalServiceDefinitionMarshaller.java?view=diff&rev=514137&r1=514136&r2=514137
==============================================================================
--- incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/java/JavaPhysicalServiceDefinitionMarshaller.java (original)
+++ incubator/tuscany/java/sca/kernel/core/src/main/java/org/apache/tuscany/core/marshaller/java/JavaPhysicalServiceDefinitionMarshaller.java Sat Mar  3 04:17:30 2007
@@ -18,79 +18,66 @@
  */
 package org.apache.tuscany.core.marshaller.java;
 
-import static javax.xml.stream.XMLStreamConstants.END_ELEMENT;
-import static javax.xml.stream.XMLStreamConstants.START_ELEMENT;
-
 import javax.xml.namespace.QName;
-import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamReader;
 import javax.xml.stream.XMLStreamWriter;
 
-import org.apache.tuscany.core.marshaller.AbstractMarshallerExtension;
+import org.apache.tuscany.core.marshaller.AbstractPhysicalServiceDefinitionMarshaller;
 import org.apache.tuscany.core.model.physical.java.JavaPhysicalServiceDefinition;
-import org.apache.tuscany.spi.marshaller.MarshallException;
-import org.apache.tuscany.spi.model.ModelObject;
-import org.apache.tuscany.spi.model.physical.PhysicalOperationDefinition;
 
 /**
  * Marshaller for java physical service definition.
  * 
  * @version $Revision$ $Date$
  */
-public class JavaPhysicalServiceDefinitionMarshaller extends AbstractMarshallerExtension<JavaPhysicalServiceDefinition> {
-
-    // Local part for operation
-    private static final String OPERATION = "operation";
-    
-    // Source name attribute
-    private static final String NAME = "name";
+public class JavaPhysicalServiceDefinitionMarshaller extends AbstractPhysicalServiceDefinitionMarshaller<JavaPhysicalServiceDefinition> {
     
     // QName for the root element
-    private static final QName QNAME = new QName("http://tuscany.apache.org/xmlns/marshaller/service/java/1.0-SNAPSHOT", "service");
+    private static final QName QNAME = new QName("http://tuscany.apache.org/xmlns/marshaller/reference/java/1.0-SNAPSHOT", "service");
 
     /**
-     * Marshalls a physical java service definition to the xml writer.
+     * Gets the qualified name of the XML fragment for the marshalled model object.
+     * @return {"http://tuscany.apache.org/xmlns/marshaller/reference/java/1.0-SNAPSHOT", "service"}.
      */
-    public void marshall(JavaPhysicalServiceDefinition modelObject, XMLStreamWriter writer) throws MarshallException {
-        throw new UnsupportedOperationException();
+    @Override
+    protected QName getModelObjectQName() {
+        return QNAME;
+    }
+
+    /**
+     * Returns the type of the model object.
+     * @return <code>JavaPhysicalServiceDefinition.class</code>.
+     */
+    @Override
+    protected Class<JavaPhysicalServiceDefinition> getModelObjectType() {
+        return JavaPhysicalServiceDefinition.class;
     }
 
     /**
-     * Unmarshalls a java physical service definition from the xml reader.
+     * Create the concrete model object.
+     * @return An instance of <code>JavaPhysicalServiceDefinition</code>.
      */
-    public JavaPhysicalServiceDefinition unmarshall(XMLStreamReader reader) throws MarshallException {
-        
-        try {
-            JavaPhysicalServiceDefinition serviceDefinition = new JavaPhysicalServiceDefinition();
-            serviceDefinition.setName(reader.getAttributeValue(null, NAME));
-            while (true) {
-                switch (reader.next()) {
-                    case START_ELEMENT:
-                        ModelObject modelObject = registry.unmarshall(reader);
-                        String name = reader.getName().getLocalPart();
-                        if(OPERATION.equals(name)) {
-                            serviceDefinition.addOperation((PhysicalOperationDefinition)modelObject);
-                        }
-                        break;
-                    case END_ELEMENT:
-                        return serviceDefinition;
-
-                }
-            }
-        } catch (XMLStreamException ex) {
-            throw new MarshallException(ex);
-        }
-        
+    @Override
+    protected JavaPhysicalServiceDefinition getConcreteModelObject() {
+        return new JavaPhysicalServiceDefinition();
     }
 
+    /**
+     * Handles extensions for unmarshalling Java service definitions.
+     * @param modelObject Concrete model object.
+     * @param reader Reader from which marshalled data is read.
+     */
     @Override
-    protected QName getModelObjectQName() {
-        return QNAME;
+    protected void handleExtensions(JavaPhysicalServiceDefinition modelObject, XMLStreamReader reader) {
     }
 
+    /**
+     * Handles extensions for marshalling Java service definitions.
+     * @param modelObject Concrete model object.
+     * @param reader Writer to which marshalled data is written.
+     */
     @Override
-    protected Class<JavaPhysicalServiceDefinition> getModelObjectType() {
-        return JavaPhysicalServiceDefinition.class;
+    protected void handleExtensions(JavaPhysicalServiceDefinition modelObject, XMLStreamWriter writer) {
     }
 
 }



---------------------------------------------------------------------
To unsubscribe, e-mail: tuscany-commits-unsubscribe@ws.apache.org
For additional commands, e-mail: tuscany-commits-help@ws.apache.org