KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > jalisto > se > api > ClassDescription


1 /*
2  * Jalisto - JAva LIght STOrage
3  * Copyright (C) 2000-2005 Xcalia http://www.xcalia.com
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
18  *
19  * Xcalia
20  * 71, rue Desnouettes
21  * 75014 Paris - France
22  * http://www.xcalia.com
23  */
24 package org.objectweb.jalisto.se.api;
25
26 import org.objectweb.jalisto.se.api.query.FieldDescription;
27 import org.objectweb.jalisto.se.api.query.FielComparator;
28
29 import java.io.Serializable JavaDoc;
30 import java.util.Iterator JavaDoc;
31
32
33 public interface ClassDescription extends Serializable JavaDoc {
34     String JavaDoc getClassName();
35
36     int getIndex(String JavaDoc fieldName);
37
38     FieldDescription getFieldDescription(int index);
39
40     FielComparator getComparator(int index);
41
42     Iterator JavaDoc getIndexedFieldDescription();
43
44     short getIndexType(int index);
45
46     void setIndexType(int index, short indexType);
47
48     short getNodePageSize(int index);
49
50     void setNodePageSize(int index, short size);
51
52     public short getNodeSize(int index);
53
54     public void setNodeSize(int index, short size);
55
56     public short getLeafPageSize(int index);
57
58     public void setLeafPageSize(int index, short size);
59
60     /**
61      * Return an array of the names of the declared fields of the described class.
62      *
63      * @return String[] The names of the described class fields.
64      */
65     public String JavaDoc[] getFieldNames();
66
67     /**
68      * Return the number of field already declared for the described class.
69      *
70      * @return int The number of declared fields.
71      */
72     public int getNbrFields();
73
74     /**
75      * Insert a new field in the description of the class.
76      *
77      * @param fieldDescription The name of the field to insert.
78      */
79     public void addField(FieldDescription fieldDescription);
80
81     /**
82      * Remove a field from the description of the class.
83      *
84      * @param index The index of the place where to remove the field.
85      */
86     public void removeField(int index);
87
88     public String JavaDoc toStringFull(int nbrTab);
89 }
90
Popular Tags