KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > xdoclet > modules > ojb > model > FeatureDescriptorDef


1 package xdoclet.modules.ojb.model;
2
3 /* Copyright 2004-2005 The Apache Software Foundation
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 /**
19  * Base class for feature descriptors (field, reference, collection).
20  *
21  * @author <a HREF="mailto:tomdz@users.sourceforge.net">Thomas Dudziak (tomdz@users.sourceforge.net)</a>
22  */
23 public abstract class FeatureDescriptorDef extends DefBase
24 {
25     /** The original feature descriptor def that this descriptor def is a copy of */
26     private FeatureDescriptorDef _originalDef;
27     /** Whether this is an inherited feature */
28     private boolean _isInherited = false;
29     /** Whether this is a nested feature */
30     private boolean _isNested = false;
31
32     /**
33      * Creates a new feature descriptor object.
34      *
35      * @param name The name of the feature
36      */
37     public FeatureDescriptorDef(String JavaDoc name)
38     {
39         super(name);
40     }
41
42     /**
43      * Creates copy of the given feature descriptor object. Note that the copy has no owner initially.
44      *
45      * @param src The original feature
46      * @param prefix A prefix for the name
47      */
48     public FeatureDescriptorDef(FeatureDescriptorDef src, String JavaDoc prefix)
49     {
50         super(src, prefix);
51         _originalDef = src;
52         _isInherited = src._isInherited;
53         _isNested = src._isNested;
54     }
55
56     /**
57      * Returns the original feature descriptor object that this one is a copy of.
58      *
59      * @return The original descriptor def or <code>null</code> if this feature is neither inherited nor nested
60      */
61     public FeatureDescriptorDef getOriginal()
62     {
63         return _originalDef;
64     }
65
66     /**
67      * Declares this feature to be inherited.
68      */
69     public void setInherited()
70     {
71         _isInherited = true;
72     }
73
74     /**
75      * Returns whether this feature has been inherited.
76      *
77      * @return <code>true</code> if this feature has been inherited
78      */
79     public boolean isInherited()
80     {
81         return _isInherited;
82     }
83     
84     /**
85      * Declares this feature to be nested.
86      */
87     public void setNested()
88     {
89         _isNested = true;
90     }
91
92     /**
93      * Returns whether this feature is a nested feature.
94      *
95      * @return <code>true</code> if this feature is nested
96      */
97     public boolean isNested()
98     {
99         return _isNested;
100     }
101 }
102
Popular Tags