Java Doc for BaseObject.java in  » Database-ORM » Torque » org » apache » torque » om » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Database ORM » Torque » org.apache.torque.om   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.apache.torque.om.BaseObject BaseObject abstract public class BaseObject implements Persistent,Serializable(Code) This class contains attributes and methods that are used by all business objects within the system. author:    Frank Y. Kim author:    John D. McNally version:    $Id: BaseObject.java 516325 2007-03-09 08:03:53Z seade $ Field Summary final public static  int NEW_ID      The constant denoting an unset numeric database identifier. Method Summary public  boolean equals(Object obj)      Compares this with another BaseObject instance. public  boolean equals(BaseObject bo)      Compares the primary key of this instance with the key of another. Parameters:   bo - The object to compare to. public  Object getByName(String field)      Retrieves a field from the object by name. public  Object getByPeerName(String name)      Retrieves a field from the object by name passed in as a String. public  Object getByPosition(int pos)      Retrieves a field from the object by position as specified in a database schema for example. protected  Log getLog()      gets a commons-logging Log based on class name. public  ObjectKey getPrimaryKey()      getter for the object primaryKey. public  TableMap getTableMap()      Retrieves the TableMap object related to this Table data. Must be overridden in generated classes. public  int hashCode()      If the primary key is not null, return the hashcode of the primary key. public  boolean isModified()      Returns whether the object has been modified. public  boolean isNew()      Returns whether the object has ever been saved. public  void resetModified()      Sets the modified state for the object to be false. abstract public  void save()      abstract public  void save(String dbName)      abstract public  void save(Connection con)      public  boolean setByName(String name, Object value)      Set a field in the object by field (Java) name. public  boolean setByPeerName(String name, Object value)      public  boolean setByPosition(int position, Object value)      Set field values by it's position (zero based) in the XML schema. public  void setModified(boolean m)      Sets the modified state for the object. public  void setNew(boolean b)      Setter for the isNew attribute. public  void setPrimaryKey(String primaryKey)      Sets the PrimaryKey for the object. public  void setPrimaryKey(SimpleKey[] primaryKey)      Sets the PrimaryKey for the object as an Object. public  void setPrimaryKey(ObjectKey primaryKey)      Sets the PrimaryKey for the object as an Object. Field Detail NEW_ID final public static int NEW_ID(Code) The constant denoting an unset numeric database identifier. Method Detail equals public boolean equals(Object obj)(Code) Compares this with another BaseObject instance. If obj is an instance of BaseObject, delegates to equals(BaseObject). Otherwise, returns false. Parameters:   obj - The object to compare to. Whether equal to the object specified. equals public boolean equals(BaseObject bo)(Code) Compares the primary key of this instance with the key of another. Parameters:   bo - The object to compare to. Whether the primary keys are equal and the object have thesame class. getByName public Object getByName(String field)(Code) Retrieves a field from the object by name. Must be overridden if called. BaseObject's implementation will throw an Error. Parameters:   field - The name of the field to retrieve. The retrieved field value getByPeerName public Object getByPeerName(String name)(Code) Retrieves a field from the object by name passed in as a String. Must be overridden if called. BaseObject's implementation will throw an Error. Parameters:   name - field name value of the field getByPosition public Object getByPosition(int pos)(Code) Retrieves a field from the object by position as specified in a database schema for example. Must be overridden if called. BaseObject's implementation will throw an Error. Parameters:   pos - field position value of the field getLog protected Log getLog()(Code) gets a commons-logging Log based on class name. a Log to write log to. getPrimaryKey public ObjectKey getPrimaryKey()(Code) getter for the object primaryKey. the object primaryKey as an Object getTableMap public TableMap getTableMap() throws TorqueException(Code) Retrieves the TableMap object related to this Table data. Must be overridden in generated classes. If BaseObject's implementation is called it will throw an Error. The associated TableMap object. hashCode public int hashCode()(Code) If the primary key is not null, return the hashcode of the primary key. Otherwise calls Object.hashCode(). an int value isModified public boolean isModified()(Code) Returns whether the object has been modified. True if the object has been modified. isNew public boolean isNew()(Code) Returns whether the object has ever been saved. This will be false, if the object was retrieved from storage or was created and then saved. true, if the object has never been persisted. resetModified public void resetModified()(Code) Sets the modified state for the object to be false. save abstract public void save() throws Exception(Code) See Also:   org.apache.torque.om.Persistent.save save abstract public void save(String dbName) throws Exception(Code) See Also:   org.apache.torque.om.Persistent.save(String) save abstract public void save(Connection con) throws Exception(Code) See Also:   org.apache.torque.om.Persistent.save(Connection) setByName public boolean setByName(String name, Object value) throws TorqueException(Code) Set a field in the object by field (Java) name. Parameters:   name - field name Parameters:   value - field value True if value was set, false if not (invalid name / protectedfield). throws:   IllegalArgumentException - if object type of value does not matchfield object type. throws:   TorqueException - If a problem occurs with the set[Field] method. setByPeerName public boolean setByPeerName(String name, Object value) throws TorqueException(Code) Set field values by Peer Field Name Parameters:   name - field name Parameters:   value - field value True if value was set, false if not (invalid name / protectedfield). throws:   IllegalArgumentException - if object type of value does not matchfield object type. throws:   TorqueException - If a problem occurs with the set[Field] method. setByPosition public boolean setByPosition(int position, Object value) throws TorqueException(Code) Set field values by it's position (zero based) in the XML schema. Parameters:   position - The field position Parameters:   value - field value True if value was set, false if not (invalid position / protectedfield). throws:   IllegalArgumentException - if object type of value does not matchfield object type. throws:   TorqueException - If a problem occurs with the set[Field] method. setModified public void setModified(boolean m)(Code) Sets the modified state for the object. Parameters:   m - The new modified state for the object. setNew public void setNew(boolean b)(Code) Setter for the isNew attribute. This method will be called by Torque-generated children and Peers. Parameters:   b - the state of the object. setPrimaryKey public void setPrimaryKey(String primaryKey) throws TorqueException(Code) Sets the PrimaryKey for the object. Parameters:   primaryKey - The new PrimaryKey for the object. exception:   TorqueException - This method will not throw any exceptionsbut this allows for children to override the method more easily setPrimaryKey public void setPrimaryKey(SimpleKey[] primaryKey) throws TorqueException(Code) Sets the PrimaryKey for the object as an Object. Parameters:   primaryKey - The new PrimaryKey for the object. exception:   TorqueException - This method will not throw any exceptionsbut this allows for children to override the method more easily setPrimaryKey public void setPrimaryKey(ObjectKey primaryKey) throws TorqueException(Code) Sets the PrimaryKey for the object as an Object. Parameters:   primaryKey - The new PrimaryKey for the object. exception:   TorqueException - This method will not throw any exceptionsbut this allows for children to override the method more easily Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)