View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  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  package org.apache.jdo.model.jdo;
19  
20  import org.apache.jdo.model.ModelException;
21  import org.apache.jdo.model.java.JavaType;
22  
23  
24  /***
25   * A JDOArray instance represents the JDO relationship metadata 
26   * of a array relationship field.
27   *
28   * @author Michael Bouschen
29   */
30  public interface JDOArray
31      extends JDORelationship 
32  {
33      /***
34       * Determines whether the values of the elements should be stored 
35       * if possible as part of the instance instead of as their own instances 
36       * in the datastore.
37       * @return <code>true</code> if the elements should be stored as part of 
38       * the instance; <code>false</code> otherwise
39       */
40      public boolean isEmbeddedElement();
41      
42      /***
43       * Set whether the values of the elements should be stored 
44       * if possible as part of the instance instead of as their own instances 
45       * in the datastore.
46       * @param embeddedElement flag indicating whether the elements should be 
47       * stored as part of the instance
48       * @exception ModelException if impossible
49       */
50      public void setEmbeddedElement(boolean embeddedElement)
51          throws ModelException;
52  
53      /*** 
54       * Get the type representation of the array component type. 
55       * @return the array component type
56       */
57      public JavaType getElementType();
58  
59  }