src/commons/org/codehaus/groovy/grails/commons/GrailsDomainClassProperty.java

   1 /* Copyright 2004-2005 the original author or authors.
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at
   6  *
   7  *      http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 package org.codehaus.groovy.grails.commons;
  16
  17 /**
  18  * A property of a GrailsDomainClass instance
  19  *
  20  * @author Graeme Rocher
  21  * @since Jul 5, 2005
  22  */
  23 public interface GrailsDomainClassProperty {
  24
  25         String IDENTITY = "id";
  26         String VERSION = "version";
  27         String TRANSIENT = "transients";
  28         String CONSTRAINTS = "constraints";
  29         String EVANESCENT = "evanescent";
  30         String RELATES_TO_MANY = "relatesToMany";
  31         String META_CLASS = "metaClass";
  32         String CLASS = "class";
  33         String MAPPING_STRATEGY = "mapWith";
  34         String MAPPED_BY = "mappedBy";
  35     String BELONGS_TO = "belongsTo";
  36         String HAS_MANY = "hasMany";
  37         String FETCH_MODE = "fetchMode";
  38     String DATE_CREATED = "dateCreated";
  39     String MAPPING = "mapping";
  40     String LAST_UPDATED = "lastUpdated";
  41
  42     String EMBEDDED = "embedded";
  43     int FETCH_EAGER = 1;
  44     int FETCH_LAZY = 0;
  45
  46
  47     /**
  48          * Returns the configured fetch mode for the property
  49          */
  50         public int getFetchMode();
  51
  52     /**
  53          * Returns the name of the property
  54          * @return The property name
  55          */
  56         public String getName();
  57         /**
  58          * Returns the type for the domain class
  59          * @return  The property type
  60          */
  61         public Class getType();
  62
  63         /**
  64          * <p>Returns the referenced property type. This differs from getType() in that in
  65          * the case of an Association it will return the type of the elements contained within the Collection,
  66          * otherwise it will delegate to getType();</p>
  67          *
  68          * @return The referenced type
  69          */
  70         public Class getReferencedPropertyType();
  71
  72         /**
  73          * <p>Returns the other side of a bidirectional association
  74          *
  75          * @return The other side of the relationship or null if not known
  76          */
  77         public GrailsDomainClassProperty getOtherSide();
  78
  79         /**
  80          * Returns the class type as a property name representation
  81          *
  82          * @return The property name representation
  83          */
  84         public String getTypePropertyName();
  85
  86         /**
  87          * Returns the parent domain class of the property instance
  88          * @return The parent domain class
  89          */
  90         public GrailsDomainClass getDomainClass();
  91         /**
  92          * Returns true if the domain class property is a persistent property
  93          * @return Whether the property is persistent
  94          */
  95         public boolean isPersistent();
  96         /**
  97          * Returns true if the property is required
  98          * @return Whether the property is optional
  99          */
 100         public boolean isOptional();
 101         /**
 102          * Returns true of the property is an identifier
 103          * @return Whether the property is the identifier
 104          */
 105         public boolean isIdentity();
 106
 107         /**
 108          * Returns true if the property is a one-to-many relationship
 109          * @return Whether it is a oneToMany
 110          */
 111         public boolean isOneToMany();
 112
 113         /**
 114          * Returns true if the property is a many-to-one relationship
 115          * @return Whether it is a manyToOne
 116          */
 117         public boolean isManyToOne();
 118
 119         /**
 120          * Returns true if the property is a many-to-many relationship
 121          * @return True if it is a manyToMany
 122          */
 123         public boolean isManyToMany();
 124
 125         /**
 126          * Returns true if the property is a bi-directional relationship
 127          * @return A boolean value
 128          */
 129         public boolean isBidirectional();
 130         /**
 131          * Returns the domain field name for this property
 132          */
 133         public String getFieldName();
 134         /**
 135          * Returns true if the property is a one-to-one relationship
 136          * @return True if it is a one-to-one relationship
 137          */
 138         public boolean isOneToOne();
 139         /**
 140          * Returns the GrailsDomainClass of a relationship property or null
 141          * if the property is not a relationship property
 142          *
 143          * @return The GrailsDomainClass
 144          */
 145         public GrailsDomainClass getReferencedDomainClass();
 146
 147         /**
 148          * Returns true if this property is a relationship property
 149          * @return True if it is an associative property
 150          */
 151         public boolean isAssociation();
 152
 153     /**
 154      * Returns true if this properties type is an enum
 155      * @return True if it is
 156      */
 157     public boolean isEnum();
 158
 159     /**
 160      * @return The natural name representation of the property (eg. 'lastName' becomes 'Last Name'
 161      */
 162     public String getNaturalName();
 163
 164     /**
 165      * Sets the references domain class on the property
 166      * @param referencedGrailsDomainClass
 167      */
 168     void setReferencedDomainClass(GrailsDomainClass referencedGrailsDomainClass);
 169
 170     /**
 171      * Sets the other side of an associative property
 172      * @param referencedProperty
 173      */
 174     void setOtherSide(GrailsDomainClassProperty referencedProperty);
 175
 176     /**
 177      * Whether the property is inherited from a super class
 178      * @return True if its inherited
 179      */
 180     boolean isInherited();
 181
 182     /**
 183      * Whether this side of the association is the "owning" side
 184      *
 185      * @return True if it is the owning side
 186      */
 187         public boolean isOwningSide();
 188
 189         /**
 190          * Whether the relationship is cirucular
 191          *
 192          * @return True if it is
 193          */
 194         public boolean isCircular();
 195
 196         /**
 197          * Retrieves the name of property referenced by this property if it is
 198          * an association and is known, otherwise null
 199          *
 200          * @return The name of the prop
 201          */
 202         public String getReferencedPropertyName();
 203
 204     /**
 205      * Returns true if this propert is an embedded component
 206      *
 207      * @return True if it is, false otherwise
 208      */
 209     boolean isEmbedded();
 210
 211     /**
 212      * If #isEmbedded returns true then this method can be called to obtain a reference to the embedded component, which implements the GrailsDomainClass
 213      * interface
 214      *
 215      * @see org.codehaus.groovy.grails.commons.GrailsDomainClass
 216      * @see GrailsDomainClassProperty#isEmbedded()
 217      *
 218      * @return The component or null if it is not an embedded component
 219      */
 220     GrailsDomainClass getComponent();
 221
 222     void setOwningSide(boolean b);
 223 }