You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jaxme-dev@ws.apache.org by jo...@apache.org on 2004/09/03 03:46:13 UTC
cvs commit: ws-jaxme/src/pm/org/apache/ws/jaxme/pm/xmldb XmlDbPM.java
jochen 2004/09/02 18:46:12
Modified: src/pm/org/apache/ws/jaxme/pm/jdbc PMJdbcImpl.java
src/pm/org/apache/ws/jaxme/pm/generator/jdbc
TableDetails.java CustomTableData.java
CustomColumnData.java JaxMeJdbcSG.java
ConnectionDetails.java
src/jaxme/org/apache/ws/jaxme/spg/impl Grammar.java
src/pm/org/apache/ws/jaxme/pm/junit SessionTest.java
src/pm/org/apache/ws/jaxme/pm/ino InoManager.java
InoObject.java InoResponseHandler.java
src/pm/org/apache/ws/jaxme/pm/impl PMImpl.java
src/xs/org/apache/ws/jaxme/xs/xml XsObject.java
ant docs.xml
src/jaxme/org/apache/ws/jaxme/impl JMMarshallerImpl.java
src/pm/org/apache/ws/jaxme/pm/xmldb XmlDbPM.java
Log:
Javadoc fixes (Lots remaining :-(
Revision Changes Path
1.3 +10 -0 ws-jaxme/src/pm/org/apache/ws/jaxme/pm/jdbc/PMJdbcImpl.java
Index: PMJdbcImpl.java
===================================================================
RCS file: /home/cvs/ws-jaxme/src/pm/org/apache/ws/jaxme/pm/jdbc/PMJdbcImpl.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- PMJdbcImpl.java 23 Jul 2004 07:18:05 -0000 1.2
+++ PMJdbcImpl.java 3 Sep 2004 01:46:12 -0000 1.3
@@ -62,22 +62,32 @@
password = pManager.getProperty("jdbc.password");
}
+ /** Returns the configured JDBC driver.
+ */
public String getJdbcDriver() {
return driver;
}
+ /** Returns the configured JDBC URL.
+ */
public String getJdbcUrl() {
return url;
}
+ /** Returns the configured JDBC user.
+ */
public String getJdbcUser() {
return user;
}
+ /** Returns the configured JDBC password.
+ */
public String getJdbcPassword() {
return password;
}
+ /** Creates a new database connection.
+ */
public Connection getConnection() throws SQLException {
return DriverManager.getConnection(getJdbcUrl(), getJdbcUser(), getJdbcPassword());
}
1.3 +10 -0 ws-jaxme/src/pm/org/apache/ws/jaxme/pm/generator/jdbc/TableDetails.java
Index: TableDetails.java
===================================================================
RCS file: /home/cvs/ws-jaxme/src/pm/org/apache/ws/jaxme/pm/generator/jdbc/TableDetails.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- TableDetails.java 23 Jul 2004 07:18:01 -0000 1.2
+++ TableDetails.java 3 Sep 2004 01:46:12 -0000 1.3
@@ -45,12 +45,18 @@
private String name;
private List keys;
+ /** Sets the tables name.
+ */
public void setName(String pName) {
name = pName;
}
+ /** Returns the tables name.
+ */
public String getName() {
return name;
}
+ /** Sets the names of the primary key columns.
+ */
public void setKeys(String pKeys) {
if (keys == null) {
keys = new ArrayList();
@@ -59,9 +65,13 @@
keys.add(st.nextToken());
}
}
+ /** Returns the names of the primary key columns.
+ */
public List getKeys() {
return keys;
}
+ /** Copies the current details from the given.
+ */
public void cloneFrom(TableDetails pFrom) {
super.cloneFrom(pFrom);
name = pFrom.name;
1.3 +12 -0 ws-jaxme/src/pm/org/apache/ws/jaxme/pm/generator/jdbc/CustomTableData.java
Index: CustomTableData.java
===================================================================
RCS file: /home/cvs/ws-jaxme/src/pm/org/apache/ws/jaxme/pm/generator/jdbc/CustomTableData.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CustomTableData.java 16 Feb 2004 23:39:54 -0000 1.2
+++ CustomTableData.java 3 Sep 2004 01:46:12 -0000 1.3
@@ -26,12 +26,24 @@
private final Table table;
private final TableDetails tableDetails;
private final ComplexTypeSG typeSG;
+ /** Creates a new instance-
+ * @param pJdbcSG The source generator creating this instance.
+ * @param pTable The table, which is currently read by the source generator.
+ * @param pTypeSG The complex type being generated.
+ * @param pTableDetails The connection details.
+ */
public CustomTableData(JaxMeJdbcSG pJdbcSG, Table pTable, ComplexTypeSG pTypeSG, TableDetails pTableDetails) {
table = pTable;
typeSG = pTypeSG;
tableDetails = pTableDetails;
}
+ /** Returns the table, which is currently being read.
+ */
public Table getTable() { return table; }
+ /** Returns the type, which is being generated.
+ */
public ComplexTypeSG getTypeSG() { return typeSG; }
+ /** Returns the connection details.
+ */
public TableDetails getTableDetails() { return tableDetails; }
}
1.3 +7 -0 ws-jaxme/src/pm/org/apache/ws/jaxme/pm/generator/jdbc/CustomColumnData.java
Index: CustomColumnData.java
===================================================================
RCS file: /home/cvs/ws-jaxme/src/pm/org/apache/ws/jaxme/pm/generator/jdbc/CustomColumnData.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CustomColumnData.java 16 Feb 2004 23:39:54 -0000 1.2
+++ CustomColumnData.java 3 Sep 2004 01:46:12 -0000 1.3
@@ -23,10 +23,17 @@
public class CustomColumnData {
private final String name;
private final Object sg;
+ /** Creates a new instance with the given name, which is
+ * attached to the given <code>pSG</code>.
+ */
public CustomColumnData(String pName, Object pSG) {
name = pName;
sg = pSG;
}
+ /** Returns the custom column datas name.
+ */
public String getName() { return name; }
+ /** Returns the custom column datas attached object.
+ */
public Object getSG() { return sg; }
}
1.6 +23 -0 ws-jaxme/src/pm/org/apache/ws/jaxme/pm/generator/jdbc/JaxMeJdbcSG.java
Index: JaxMeJdbcSG.java
===================================================================
RCS file: /home/cvs/ws-jaxme/src/pm/org/apache/ws/jaxme/pm/generator/jdbc/JaxMeJdbcSG.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- JaxMeJdbcSG.java 27 Jul 2004 11:19:25 -0000 1.5
+++ JaxMeJdbcSG.java 3 Sep 2004 01:46:12 -0000 1.6
@@ -85,10 +85,16 @@
public class JaxMeJdbcSG extends SGFactoryChainImpl {
Logger log = LoggerAccess.getLogger(JaxMeJdbcSG.class);
+ /** A database mode specifies, how JDBC metadata is
+ * being interpreted. The main use is for Oracle, which
+ * has a rather peculiar understanding of JDBC metadata.
+ */
public static class Mode {
private String name;
private Mode(String pName) { name = pName; }
public String toString() { return name; }
+ /** Returns the modes name.
+ */
public String getName() { return name; }
public int hashCode() { return name.hashCode(); }
public boolean equals(Object o) {
@@ -98,6 +104,10 @@
return name.equals(((Mode) o).name);
}
}
+ /** Returns an instance of <code>Mode</code> with
+ * the given name.
+ * @throws IllegalArgumentException The mode name is invalid.
+ */
public static Mode valueOf(String pMode) {
if ("GENERIC".equalsIgnoreCase(pMode)) {
return GENERIC;
@@ -129,6 +139,8 @@
private final boolean isOptional;
private final XSObject parent;
+ /** An attribute, which matches a database column.
+ */
public JdbcAttribute(XSObject pParent, Locator pLocator, XsQName pName, XSType pType, boolean pOptional) {
parent = pParent;
locator = pLocator;
@@ -138,6 +150,10 @@
}
public boolean isGlobal() { return false; }
+ /** For compatibility only: The value true is unsupported.
+ * @throws IllegalStateException An attempt was made, to make the
+ * attribute public.
+ */
public void setGlobal(boolean pGlobal) {
if (!pGlobal) {
throw new IllegalStateException("This attribute cannot be made global");
@@ -166,10 +182,15 @@
private SQLFactory sqlFactory;
private String key;
+ /** Creates a new instance.
+ */
public JaxMeJdbcSG(SGFactoryChain o) {
super(o);
}
+ /** Returns the key, under which the {@link JaxMeJdbcSG} is
+ * registered in the factory.
+ */
public String getKey() {
return key;
}
@@ -386,6 +407,8 @@
* class, even if they don't have the javax.sql package around.</p>
*/
private interface Connector {
+ /** Returns a new database connection.
+ */
public Connection getConnection(TableDetails pDetails) throws SAXException;
}
1.3 +40 -0 ws-jaxme/src/pm/org/apache/ws/jaxme/pm/generator/jdbc/ConnectionDetails.java
Index: ConnectionDetails.java
===================================================================
RCS file: /home/cvs/ws-jaxme/src/pm/org/apache/ws/jaxme/pm/generator/jdbc/ConnectionDetails.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ConnectionDetails.java 23 Jul 2004 07:18:01 -0000 1.2
+++ ConnectionDetails.java 3 Sep 2004 01:46:12 -0000 1.3
@@ -35,40 +35,80 @@
private Mode mode;
private String driver, url, user, password, datasource;
private Boolean usingDatasource;
+ /** Sets the JDBC driver.
+ */
public void setDriver(String pDriver) { driver = pDriver; }
+ /** Returns the JDBC driver.
+ */
public String getDriver() {
return this.jdbcSG.getSGFactory().getGenerator().getProperty("jdbc.driver", driver);
}
+ /** Sets the JDBC URL.
+ */
public void setUrl(String pUrl) { url = pUrl; }
+ /** Returns the JDBC URL.
+ */
public String getUrl() {
return this.jdbcSG.getSGFactory().getGenerator().getProperty("jdbc.url", url);
}
+ /** Sets the JDBC user.
+ */
public void setUser(String pUser) { user = pUser; }
+ /** Returns the JDBC user.
+ */
public String getUser() {
return this.jdbcSG.getSGFactory().getGenerator().getProperty("jdbc.user", user);
}
+ /** Sets the JDBC password.
+ */
public void setPassword(String pPassword) { password = pPassword; }
+ /** Returns the JDBC password.
+ */
public String getPassword() {
return this.jdbcSG.getSGFactory().getGenerator().getProperty("jdbc.password", password);
}
+ /** Sets the JDBC datasource.
+ * @see #setUsingDatasource(Boolean)
+ */
public void setDatasource(String pDatasource) { datasource = pDatasource; }
+ /** Returns the JDBC datasource.
+ * @see #isUsingDatasource()
+ */
public String getDatasource() {
return this.jdbcSG.getSGFactory().getGenerator().getProperty("jdbc.datasource", datasource);
}
+ /** Sets, whether a JDBC datasource is being used. By default
+ * the JDBC driver and URL are used.
+ */
public void setUsingDatasource(Boolean pUsingDatasource) {
usingDatasource = pUsingDatasource;
}
+ /** Returns, whether a JDBC datasource is being used. By default
+ * the JDBC driver and URL are used.
+ */
public Boolean isUsingDatasource() {
String s = this.jdbcSG.getSGFactory().getGenerator().getProperty("jdbc.usingDatasource");
return s == null ? usingDatasource : Boolean.valueOf(s);
}
+ /** Sets the database mode. Must be either of
+ * {@link org.apache.ws.jaxme.pm.generator.jdbc.JaxMeJdbcSG.Mode#GENERIC}
+ * (default), or
+ * {@link org.apache.ws.jaxme.pm.generator.jdbc.JaxMeJdbcSG.Mode#ORACLE}.
+ */
public void setDbMode(String pMode) {
mode = Mode.valueOf(pMode);
}
+ /** Returns the database mode. Either of
+ * {@link org.apache.ws.jaxme.pm.generator.jdbc.JaxMeJdbcSG.Mode#GENERIC}
+ * (default), or
+ * {@link org.apache.ws.jaxme.pm.generator.jdbc.JaxMeJdbcSG.Mode#ORACLE}.
+ */
public Mode getDbMode() {
String s = this.jdbcSG.getSGFactory().getGenerator().getProperty("jdbc.dbMode");
return s == null ? mode : Mode.valueOf(s);
}
+ /** Copies the given details into the current.
+ */
public void cloneFrom(ConnectionDetails pFrom) {
mode = pFrom.mode;
driver = pFrom.driver;
1.2 +1 -1 ws-jaxme/src/jaxme/org/apache/ws/jaxme/spg/impl/Grammar.java
Index: Grammar.java
===================================================================
RCS file: /home/cvs/ws-jaxme/src/jaxme/org/apache/ws/jaxme/spg/impl/Grammar.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Grammar.java 15 Aug 2004 11:46:27 -0000 1.1
+++ Grammar.java 3 Sep 2004 01:46:12 -0000 1.2
@@ -79,7 +79,7 @@
minOccurs = pMinOccurs;
maxOccurs = pMaxOccurs;
}
- /** <p>Returns the referenced {@link Token}.</p>
+ /** <p>Returns the referenced {@link Grammar.Token}.</p>
*/
public Token getToken() { return referencedToken; }
/** <p>Returns the minimum number of occurrences.</p>
1.3 +25 -0 ws-jaxme/src/pm/org/apache/ws/jaxme/pm/junit/SessionTest.java
Index: SessionTest.java
===================================================================
RCS file: /home/cvs/ws-jaxme/src/pm/org/apache/ws/jaxme/pm/junit/SessionTest.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SessionTest.java 23 Jul 2004 07:17:58 -0000 1.2
+++ SessionTest.java 3 Sep 2004 01:46:12 -0000 1.3
@@ -31,9 +31,13 @@
import org.apache.ws.jaxme.test.pm.session.impl.SessionTypePM;
+/** Unit test for the JDBC manager.
+ */
public class SessionTest extends TestCase {
private static int num;
+ /** Creates a new instance of the test with the given name.
+ */
public SessionTest(String pName) {
super(pName);
}
@@ -62,10 +66,14 @@
return session;
}
+ /** Tests, whether the factory can be created.
+ */
public void testCreateFactory() throws Exception {
getFactory();
}
+ /** Tests, whether a manager created.
+ */
public void testCreateManager() throws Exception {
PM pm = getPM();
assertTrue(pm instanceof SessionTypePM);
@@ -75,6 +83,9 @@
assertTrue(conn.getAutoCommit());
}
+ /** Tests, whether all entries can be removed from
+ * the database.
+ */
public void testClear() throws Exception {
PM pm = getPM();
for (Iterator iter = pm.select(null); iter.hasNext(); ) {
@@ -82,11 +93,17 @@
}
}
+ /** Tests, whether a new row can be created,
+ * which is not stored into the database.
+ */
public void testCreate() throws Exception {
PM pm = getPM();
getSession(pm);
}
+ /** Tests, whether a new row can be created
+ * and stored into the database.
+ */
public void testInsert() throws Exception {
PM pm = getPM();
Session session = getSession(pm);
@@ -98,6 +115,8 @@
pm.insert(session);
}
+ /** Test, that reads all rows from the database.
+ */
public void testSelectAll() throws Exception {
PM pm = getPM();
Iterator iter = pm.select("1=1 ORDER BY ID");
@@ -110,6 +129,8 @@
assertTrue(!iter.hasNext());
}
+ /** Test, that reads a single row from the database.
+ */
public void testSelect() throws Exception {
PM pm = getPM();
Iterator iter = pm.select("IPADDRESS='192.168.5.127'");
@@ -121,6 +142,8 @@
assertTrue(!pm.select("IPADDRESS='192.168.5.128'").hasNext());
}
+ /** Test, that updates a row in the database.
+ */
public void testUpdate() throws Exception {
PM pm = getPM();
Iterator iter = pm.select("IPADDRESS='192.168.5.127'");
@@ -144,6 +167,8 @@
testSelect();
}
+ /** Test, that deletes a row in the database.
+ */
public void testDelete() throws Exception {
testClear();
PM pm = getPM();
1.5 +16 -0 ws-jaxme/src/pm/org/apache/ws/jaxme/pm/ino/InoManager.java
Index: InoManager.java
===================================================================
RCS file: /home/cvs/ws-jaxme/src/pm/org/apache/ws/jaxme/pm/ino/InoManager.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- InoManager.java 23 Jul 2004 07:17:58 -0000 1.4
+++ InoManager.java 3 Sep 2004 01:46:12 -0000 1.5
@@ -61,18 +61,34 @@
return password;
}
+ /** Returns the qualified element name of the root element.
+ * This is used in delete or select queries for creation
+ * of an XPath query.
+ */
public String getElementTag() {
return elementTag;
}
+ /** Sets the qualified element name of the root element.
+ * This is used in delete or select queries for creation
+ * of an XQL statement.
+ */
public void setElementTag(String pElementTag) {
elementTag = pElementTag;
}
+ /** Returns the qualified attribute name of the ID attribute.
+ * This is used in delete or update queries for creation
+ * of an XQL statement.
+ */
public String getIdTag() {
return idTag;
}
+ /** Returns the qualified attribute name of the ID attribute.
+ * This is used in delete or update queries for creation
+ * of an XQL statement.
+ */
public void setIdTag(String pIdTag) {
idTag = pIdTag;
}
1.3 +14 -0 ws-jaxme/src/pm/org/apache/ws/jaxme/pm/ino/InoObject.java
Index: InoObject.java
===================================================================
RCS file: /home/cvs/ws-jaxme/src/pm/org/apache/ws/jaxme/pm/ino/InoObject.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- InoObject.java 23 Jul 2004 07:17:58 -0000 1.2
+++ InoObject.java 3 Sep 2004 01:46:12 -0000 1.3
@@ -23,11 +23,25 @@
* @author <a href="mailto:joe@ispsoft.de">Jochen Wiedmann</a>
*/
public interface InoObject extends JMElement {
+ /** Sets the objects document name. May be null,
+ * because a document is typically not required.
+ */
public void setInoDocname(String pDocname);
+ /** Sets the objects ino:id. May be null,
+ * because an ino:id is no longer required
+ * nowadays.
+ */
public void setInoId(String pId);
+ /** Returns the objects document name. May be null,
+ * because a document is typically not required.
+ */
public String getInoDocname();
+ /** Returns the objects ino:id. May be null,
+ * because an ino:id is no longer required
+ * nowadays.
+ */
public String getInoId();
}
1.4 +4 -0 ws-jaxme/src/pm/org/apache/ws/jaxme/pm/ino/InoResponseHandler.java
Index: InoResponseHandler.java
===================================================================
RCS file: /home/cvs/ws-jaxme/src/pm/org/apache/ws/jaxme/pm/ino/InoResponseHandler.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- InoResponseHandler.java 23 Jul 2004 07:17:58 -0000 1.3
+++ InoResponseHandler.java 3 Sep 2004 01:46:12 -0000 1.4
@@ -54,6 +54,10 @@
locator = l;
}
+ /** Returns the document {@link Locator}, that was
+ * previously set by the XML parser. May be null, if
+ * the parser didn't supply one.
+ */
public Locator getDocumentLocator() {
return locator;
}
1.4 +8 -0 ws-jaxme/src/pm/org/apache/ws/jaxme/pm/impl/PMImpl.java
Index: PMImpl.java
===================================================================
RCS file: /home/cvs/ws-jaxme/src/pm/org/apache/ws/jaxme/pm/impl/PMImpl.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- PMImpl.java 16 Feb 2004 23:39:59 -0000 1.3
+++ PMImpl.java 3 Sep 2004 01:46:12 -0000 1.4
@@ -59,8 +59,16 @@
return select(pQuery, null);
}
+ /** The <code>ListObserver</code> is a basic
+ * {@link Observer}, which collects result objects
+ * in a {@link List}.
+ */
public static class ListObserver implements Observer {
private List list;
+ /** Creates a new <code>ListObserver</code>, which writes
+ * the received objects into the {@link List}
+ * <code>pList</code>.
+ */
public ListObserver(List pList) {
list = pList;
}
1.3 +12 -10 ws-jaxme/src/xs/org/apache/ws/jaxme/xs/xml/XsObject.java
Index: XsObject.java
===================================================================
RCS file: /home/cvs/ws-jaxme/src/xs/org/apache/ws/jaxme/xs/xml/XsObject.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- XsObject.java 16 Feb 2004 23:39:46 -0000 1.2
+++ XsObject.java 3 Sep 2004 01:46:12 -0000 1.3
@@ -20,21 +20,22 @@
import org.xml.sax.SAXException;
-/** <p>Base interface for all the types, attributes, elements, ...</p>
+/** Base interface for type, attribute, element, or whatever object.
*
* @author <a href="mailto:joe@ispsoft.de">Jochen Wiedmann</a>
*/
public interface XsObject {
- /** <p>Returns the objects syntactical schema.</p>
+ /** Returns the objects syntactical schema.
*/
public XsESchema getXsESchema();
- /** <p>Returns whether the object is a top-level object. This is
- * the case for the XsESchema itself and for all its childs only.</p>
+ /** Returns whether the object is a top-level object. This is
+ * the case for the XsESchema itself and for all its childs only.
*/
public boolean isTopLevelObject();
- /** <p>Returns either of the following:
+ /** Returns information on the parent object.<br>
+ * More precisely, returns either of the following:
* <ul>
* <li>If the object is the schema itself, returns null. The
* schema doesn't have a parent object.</p>
@@ -46,17 +47,18 @@
*/
public XsObject getParentObject();
- /** <p>Returns the {@link XsObjectFactory object factory}, that
- * created this instance.</p>
+ /** Returns the {@link XsObjectFactory object factory}, that
+ * created this instance.
*/
public XsObjectFactory getObjectFactory();
- /** <p>Returns the SAX {@link Locator} with the instances
- * location.</p>
+ /** Returns the SAX {@link Locator} with the instances
+ * location.
*/
public Locator getLocator();
- /** <p>Validates the types, attributes, elements, ... internal state.</p>
+ /** Validates the internal state of the type, attribute, element,
+ * or whatever object.
*/
public void validate() throws SAXException;
}
1.3 +8 -2 ws-jaxme/ant/docs.xml
Index: docs.xml
===================================================================
RCS file: /home/cvs/ws-jaxme/ant/docs.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- docs.xml 20 Aug 2004 23:43:29 -0000 1.2
+++ docs.xml 3 Sep 2004 01:46:12 -0000 1.3
@@ -72,14 +72,20 @@
<target name="all" depends="javadoc,docbook.html,old.releases,forrest,replace"
description="Generates the documentation"/>
- <target name="javadoc" depends="JM.all"
+ <target name="javadoc" depends="all"
description="Generates the API documentation">
<delete dir="${build.apidocs}"/>
<mkdir dir="${build.apidocs}"/>
+ <path id="docs.class.path">
+ <path refid="pm.class.path"/>
+ <path refid="xs.class.path"/>
+ <path refid="js.class.path"/>
+ <path refid="jaxme.class.path"/>
+ </path>
<javadoc
access="protected"
author="true"
- classpathref="jaxme.class.path"
+ classpathref="docs.class.path"
destdir="${build.apidocs}"
nodeprecated="false"
nodeprecatedlist="false"
1.8 +24 -21 ws-jaxme/src/jaxme/org/apache/ws/jaxme/impl/JMMarshallerImpl.java
Index: JMMarshallerImpl.java
===================================================================
RCS file: /home/cvs/ws-jaxme/src/jaxme/org/apache/ws/jaxme/impl/JMMarshallerImpl.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- JMMarshallerImpl.java 26 Aug 2004 22:41:24 -0000 1.7
+++ JMMarshallerImpl.java 3 Sep 2004 01:46:12 -0000 1.8
@@ -46,51 +46,54 @@
* @version $Id$
*/
public class JMMarshallerImpl extends JMControllerImpl implements JMMarshaller {
- /** <p>Default value for {@link Marshaller#JAXB_ENCODING}: UTF-8.</p>
+ /** Default value for {@link Marshaller#JAXB_ENCODING}.
+ * (UTF-8 encoding)
*/
public static final String DEFAULT_JAXB_ENCODING = "UTF-8";
- /** <p>Default value for {@link #JAXME_INDENTATION_STRING}: " "
- *(two blanks)</p>
+ /** Default value for {@link #JAXME_INDENTATION_STRING}.
+ * (" ", two blanks)
*/
public static final String DEFAULT_JAXME_INDENTATION_STRING = " ";
- /** <p>Default value for {@link #JAXME_INDENTATION_SEPARATOR}: "\n"
- * (Line Feed)</p>
+ /** Default value for {@link #JAXME_INDENTATION_SEPARATOR}.
+ * ("\n", Line Feed)
*/
public static final String DEFAULT_JAXME_INDENTATION_SEPARATOR = "\n";
- /** <p>Property name for setting the String used to indent
- * the formatted output by one level: "jaxme.indentation.string".
- * Defaults to {@link #DEFAULT_JAXME_INDENTATION_STRING}.</p>
+ /** Property name for setting the String used to indent
+ * the formatted output by one level.
+ * ("jaxme.indentation.string")
+ * Defaults to {@link #DEFAULT_JAXME_INDENTATION_STRING}.
*
* @see #setIndentationString
* @see #getIndentationString
*/
public static final String JAXME_INDENTATION_STRING = "jaxme.indentation.string";
- /** <p>Property name for setting the String used as a
- * line separator in the formatted output. "jaxme.indentation.separator"</p>
+ /** Property name for setting the String used as a
+ * line separator in the formatted output.
+ * ("jaxme.indentation.separator")
*
* @see #setIndentationSeparator
* @see #getIndentationSeparator
*/
public static final String JAXME_INDENTATION_SEPARATOR = "jaxme.indentation.separator";
- /** <p>Property name for choosing whether the marshalled
+ /** Property name for choosing whether the marshalled
* output should contain an XML declaration. The methods
* {@link #marshal(Object, OutputStream)} and
* {@link #marshal(Object, Writer)} recognize
- * requests for XML declarations.</p>
+ * requests for XML declarations.
*
* @see #setXmlDeclaration(boolean)
* @see #getXmlDeclaration
*/
public static final String JAXME_XML_DECLARATION = "jaxme.xml.declaration";
- /** <p>Property name for a SAX {@link ContentHandler} which is able to
+ /** Property name for a SAX {@link ContentHandler} which is able to
* marshal a SAX stream into a character stream. The property value is
- * an instance of {@link Class} implementing {@link XMLWriter}.</p>
+ * an instance of {@link Class} implementing {@link XMLWriter}.
*/
public static final String JAXME_XML_WRITER = "jaxme.xml.writer";
@@ -114,8 +117,8 @@
private Class xmlWriterClass;
private String noNamespaceSchemaLocation, schemaLocation;
- /** <p>Sets the controllers encoding; to be used in
- * marshalling. Defaults to {@link #DEFAULT_JAXB_ENCODING}.</p>
+ /** Sets the controllers encoding; to be used in
+ * marshalling. Defaults to {@link #DEFAULT_JAXB_ENCODING}.
*
* @param pEncoding Suggested encoding or null to restore
* the default
@@ -127,13 +130,13 @@
encoding = pEncoding;
}
- /** <p>Returns the controllers encoding; to be used in
- * marshalling. Defaults to {@link #DEFAULT_JAXB_ENCODING}.</p>
+ /** Returns the controllers encoding; to be used in
+ * marshalling. Defaults to {@link #DEFAULT_JAXB_ENCODING}.
*/
public String getEncoding() { return encoding; }
- /** <p>Sets the controllers class implementing {@link XMLWriter}.
- * Defaults to {@link XMLWriterImpl}.</p>
+ /** Sets the controllers class implementing {@link XMLWriter}.
+ * Defaults to {@link XMLWriterImpl}.
*
* @param pClass A class implementing {@link XMLWriterImpl} or
* null to restore the default.
1.5 +23 -24 ws-jaxme/src/pm/org/apache/ws/jaxme/pm/xmldb/XmlDbPM.java
Index: XmlDbPM.java
===================================================================
RCS file: /home/cvs/ws-jaxme/src/pm/org/apache/ws/jaxme/pm/xmldb/XmlDbPM.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- XmlDbPM.java 27 Jul 2004 11:19:25 -0000 1.4
+++ XmlDbPM.java 3 Sep 2004 01:46:12 -0000 1.5
@@ -42,13 +42,12 @@
import org.xmldb.api.modules.XPathQueryService;
-/** <p>This is a persistence manager for the XML::DB interface. In other
+/** This is a persistence manager for the XML::DB interface. In other
* words, using this persistence manager you may read documents from a
* database via the XML::DB API or write them into the database using the
- * same API.</p>
- * <p>This persistence manager is generic: The same manager works fine for
- * any JAXB element.</p>
- * @author <a href="mailto:joe@ispsoft.de">Jochen Wiedmann</a>
+ * same API.<br>
+ * This persistence manager is generic: The same manager works fine for
+ * any JAXB element.
*/
public class XmlDbPM extends PMIdImpl {
private Class driverClass;
@@ -59,7 +58,7 @@
private String xPathQueryService = "XPathQueryService";
private String xPathQueryServiceVersion = "1.0";
- /** <p>Creates a new instance of <code>XmlDbPM</code>.</p>
+ /** Creates a new instance of <code>XmlDbPM</code>.
*/
public XmlDbPM() {
}
@@ -115,84 +114,84 @@
setDriverClass(c);
}
- /** <p>Returns the collection name.</p>
+ /** Returns the collection name.
*/
public String getCollection() {
return collection;
}
- /** <p>Sets the collection name.</p>
+ /** Sets the collection name.
*/
public void setCollection(String pCollection) {
collection = pCollection;
}
- /** <p>Returns the driver class.</p>
+ /** Returns the driver class.
*/
public Class getDriverClass() {
return driverClass;
}
- /** <p>Sets the driver class.</p>
+ /** Sets the driver class.
*/
public void setDriverClass(Class pDriverClass) {
driverClass = pDriverClass;
}
- /** <p>Returns the password.</p>
+ /** Returns the password.
*/
public String getPassword() {
return password;
}
- /** <p>Sets the password.</p>
+ /** Sets the password.
*/
public void setPassword(String pPassword) {
password = pPassword;
}
- /** <p>Returns the users name.</p>
+ /** Returns the users name.
*/
public String getUser() {
return user;
}
- /** <p>Sets the users name.</p>
+ /** Sets the users name.
*/
public void setUser(String pUser) {
user = pUser;
}
- /** <p>Returns the name of the XPathQueryService. Defaults to
- * "XPathQueryService".</p>
+ /** Returns the name of the XPathQueryService. Defaults to
+ * "XPathQueryService".
*/
public String getXPathQueryService() {
return xPathQueryService;
}
- /** <p>Sets the name of the XPathQueryService. Defaults to
- * "XPathQueryService".</p>
+ /** Sets the name of the XPathQueryService. Defaults to
+ * "XPathQueryService".
*/
public void setXPathQueryService(String pXpathQueryService) {
xPathQueryService = pXpathQueryService;
}
- /** <p>Returns the version of the XPathQueryService. Defaults to
- * "1.0".</p>
+ /** Returns the version of the XPathQueryService. Defaults to
+ * "1.0".
*/
public String getXPathQueryServiceVersion() {
return xPathQueryServiceVersion;
}
- /** <p>Sets the version of the XPathQueryService. Defaults to
- * "1.0".</p>
+ /** Sets the version of the XPathQueryService. Defaults to
+ * "1.0".
*/
public void setXPathQueryServiceVersion(String pXpathQueryServiceVersion) {
xPathQueryServiceVersion = pXpathQueryServiceVersion;
}
- /** <p>Performs the database collection and invokes
- * {@link DatabaseManager#getCollection(String)}.</p>
+ /** Returns the database collection by invoking
+ * {@link DatabaseManager#getCollection(String)}.
*/
protected Collection getXmlDbCollection()
throws XMLDBException, IllegalAccessException, InstantiationException {
---------------------------------------------------------------------
To unsubscribe, e-mail: jaxme-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: jaxme-dev-help@ws.apache.org