Author: tfischer Date: Fri May 3 21:09:26 2013 New Revision: 1478981 URL: http://svn.apache.org/r1478981 Log: Starting to add javadoc to the typed model.
Added: db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/package.html Modified: db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/Column.java Modified: db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/Column.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/Column.java?rev=1478981&r1=1478980&r2=1478981&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/Column.java (original) +++ db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/Column.java Fri May 3 21:09:26 2013 @@ -1,9 +1,5 @@ package org.apache.torque.templates.model; -import java.util.ArrayList; -import java.util.List; - - /* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file @@ -23,6 +19,9 @@ import java.util.List; * under the License. */ +import java.util.ArrayList; +import java.util.List; + /** * The model of the column tag in a Torque schema file. * @@ -32,42 +31,70 @@ public class Column { // Torque schema properties + /** The table to which the column belongs. */ public Table parent; + /** The list of options for this column. */ public List<Option> optionList = new ArrayList<Option>(); + /** The list of inheritances for this column. */ public List<Inheritance> inheritanceList = new ArrayList<Inheritance>(); + /** The column's name. */ public String name; + /** The type of the column. */ public String type; + /** How many decimal places, characters or bytes the column can take. */ public String size; + /** The scale of the column. */ public String scale; + /** The default value of the column. */ public String _default; + /** + * Whether the database default value should be used when saving + * this column. + */ public Boolean useDatabaseDefaultValue; + /** Whether this column is a primary key of this column. */ public Boolean primaryKey; + /** + * Whether this column should be automatically set by whatever + * id generation mechanism used for this column. + */ public Boolean autoIncrement; + /** Whether this column is required to be not-null. */ public Boolean required; + /** The field name for the column in the database object. */ public String javaName; + /** The type of the field for the column in the database object. */ public String javaType; + /** The domain reference name to set common settings. */ public String domain; + /** The inheritance method used. */ public String inheritanceType; + /** + * Whether getters and setters for the field in the database object + * should be public instead of protected. + */ public Boolean _protected; + /** Whether this column is a version column. */ public Boolean version; + /** The description of (== comment for) the column. */ public String description; // SQL generation properties Added: db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/package.html URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/package.html?rev=1478981&view=auto ============================================================================== --- db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/package.html (added) +++ db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/package.html Fri May 3 21:09:26 2013 @@ -0,0 +1,29 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you 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. +--> +<html> +<head> +<title>Platform package</title> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</head> + +<body bgcolor="#FFFFFF"> +This package contains the typed model for the torque schema. +Each class represents an xml element in the torque schema. +</body> +</html> --------------------------------------------------------------------- To unsubscribe, e-mail: torque-dev-unsubscr...@db.apache.org For additional commands, e-mail: torque-dev-h...@db.apache.org