Author: rfeng
Date: Mon Oct  8 14:44:24 2007
New Revision: 582985

URL: http://svn.apache.org/viewvc?rev=582985&view=rev
Log:
Add more comments

Modified:
    
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/AccountData.java
    
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/AccountService.java
    
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/CurrencyExchange.java
    
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/ExchangeRate.java
    
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/ExchangeRateImpl.java
    
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/StockQuote.java
    
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/StockValue.java

Modified: 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/AccountData.java
URL: 
http://svn.apache.org/viewvc/incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/AccountData.java?rev=582985&r1=582984&r2=582985&view=diff
==============================================================================
--- 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/AccountData.java
 (original)
+++ 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/AccountData.java
 Mon Oct  8 14:44:24 2007
@@ -27,5 +27,10 @@
  * @version $Rev$ $Date$
  */
 public interface AccountData {
+    /**
+     * Get the StAX stream that represent the accounts data
+     * @return The StAX stream containign the accounts
+     * @throws IOException
+     */
     XMLStreamReader getAccounts() throws IOException;
 }

Modified: 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/AccountService.java
URL: 
http://svn.apache.org/viewvc/incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/AccountService.java?rev=582985&r1=582984&r2=582985&view=diff
==============================================================================
--- 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/AccountService.java
 (original)
+++ 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/AccountService.java
 Mon Oct  8 14:44:24 2007
@@ -24,5 +24,9 @@
  * @version $Rev$ $Date$
  */
 public interface AccountService {
+    /**
+     * Get the total value of all accounts owned by the customer
+     * @return The total value
+     */
     double getTotalValue();
 }

Modified: 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/CurrencyExchange.java
URL: 
http://svn.apache.org/viewvc/incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/CurrencyExchange.java?rev=582985&r1=582984&r2=582985&view=diff
==============================================================================
--- 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/CurrencyExchange.java
 (original)
+++ 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/CurrencyExchange.java
 Mon Oct  8 14:44:24 2007
@@ -28,5 +28,9 @@
  */
 @Remotable
 public interface CurrencyExchange {
+    /**
+     * Get the currency exchange rates as a RSS feed
+     * @return
+     */
     Feed getRates();
 }

Modified: 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/ExchangeRate.java
URL: 
http://svn.apache.org/viewvc/incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/ExchangeRate.java?rev=582985&r1=582984&r2=582985&view=diff
==============================================================================
--- 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/ExchangeRate.java
 (original)
+++ 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/ExchangeRate.java
 Mon Oct  8 14:44:24 2007
@@ -23,5 +23,10 @@
  * @version $Rev$ $Date$
  */
 public interface ExchangeRate {
+    /**
+     * Look up the exchange rate of a currency against USD
+     * @param currency The currency
+     * @return The exchange rate
+     */
     double getExchangeRate(String currency);
 }

Modified: 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/ExchangeRateImpl.java
URL: 
http://svn.apache.org/viewvc/incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/ExchangeRateImpl.java?rev=582985&r1=582984&r2=582985&view=diff
==============================================================================
--- 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/ExchangeRateImpl.java
 (original)
+++ 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/ExchangeRateImpl.java
 Mon Oct  8 14:44:24 2007
@@ -24,11 +24,9 @@
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
-import javax.xml.stream.XMLStreamException;
 import javax.xml.xpath.XPath;
 import javax.xml.xpath.XPathConstants;
 import javax.xml.xpath.XPathExpression;
-import javax.xml.xpath.XPathExpressionException;
 import javax.xml.xpath.XPathFactory;
 
 import org.osoa.sca.ServiceRuntimeException;
@@ -59,9 +57,10 @@
     }
 
     /**
-     * @return
-     * @throws XMLStreamException
-     * @throws XPathExpressionException
+     * Retrieve the live currency exchange rate from a live feed and extract 
the data for a given
+     * currecy using XPath
+     * @param currency The currency
+     * @return The exchange rate
      */
     public double getExchangeRate(String currency) {
         try {

Modified: 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/StockQuote.java
URL: 
http://svn.apache.org/viewvc/incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/StockQuote.java?rev=582985&r1=582984&r2=582985&view=diff
==============================================================================
--- 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/StockQuote.java
 (original)
+++ 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/StockQuote.java
 Mon Oct  8 14:44:24 2007
@@ -28,5 +28,10 @@
  */
 @Remotable
 public interface StockQuote {
+    /**
+     * Invoke the stock quote web service to get the live quotes
+     * @param input The StAX stream of the request
+     * @return The StAX stream of the response
+     */
     public XMLStreamReader GetStockQuotes(XMLStreamReader input);
 }

Modified: 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/StockValue.java
URL: 
http://svn.apache.org/viewvc/incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/StockValue.java?rev=582985&r1=582984&r2=582985&view=diff
==============================================================================
--- 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/StockValue.java
 (original)
+++ 
incubator/tuscany/java/sca/demos/xml-bigbank/src/main/java/bigbank/StockValue.java
 Mon Oct  8 14:44:24 2007
@@ -28,5 +28,11 @@
  */
 @Remotable
 public interface StockValue {
+    /**
+     * Join the quotes and accounts document to calculate the value
+     * @param quotes The quotes XML document
+     * @param accounts The accounts XML document
+     * @return The value
+     */
     double calculate(XMLStreamReader quotes, XMLStreamReader accounts);
 }



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to