KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > derby > catalog > AliasInfo


1 /*
2
3    Derby - Class org.apache.derby.catalog.AliasInfo
4
5    Licensed to the Apache Software Foundation (ASF) under one or more
6    contributor license agreements. See the NOTICE file distributed with
7    this work for additional information regarding copyright ownership.
8    The ASF licenses this file to You under the Apache License, Version 2.0
9    (the "License"); you may not use this file except in compliance with
10    the License. You may obtain a copy of the License at
11
12       http://www.apache.org/licenses/LICENSE-2.0
13
14    Unless required by applicable law or agreed to in writing, software
15    distributed under the License is distributed on an "AS IS" BASIS,
16    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17    See the License for the specific language governing permissions and
18    limitations under the License.
19
20  */
21
22 package org.apache.derby.catalog;
23
24 /**
25  *
26  * An interface for describing an alias in Cloudscape systems.
27  *
28  * In a Cloudscape system, an alias can be one of the following:
29  * <ul>
30  * <li>method alias
31  * <li>class alias
32  * <li>synonym
33  * <li>user-defined aggregate
34  * </ul>
35  *
36  */
37 public interface AliasInfo
38 {
39     /**
40      * Public statics for the various alias types as both char and String.
41      */
42     public static final char ALIAS_TYPE_PROCEDURE_AS_CHAR = 'P';
43     public static final char ALIAS_TYPE_FUNCTION_AS_CHAR = 'F';
44     public static final char ALIAS_TYPE_SYNONYM_AS_CHAR = 'S';
45
46     public static final String JavaDoc ALIAS_TYPE_PROCEDURE_AS_STRING = "P";
47     public static final String JavaDoc ALIAS_TYPE_FUNCTION_AS_STRING = "F";
48     public static final String JavaDoc ALIAS_TYPE_SYNONYM_AS_STRING = "S";
49
50     /**
51      * Public statics for the various alias name spaces as both char and String.
52      */
53     public static final char ALIAS_NAME_SPACE_PROCEDURE_AS_CHAR = 'P';
54     public static final char ALIAS_NAME_SPACE_FUNCTION_AS_CHAR = 'F';
55     public static final char ALIAS_NAME_SPACE_SYNONYM_AS_CHAR = 'S';
56
57     public static final String JavaDoc ALIAS_NAME_SPACE_PROCEDURE_AS_STRING = "P";
58     public static final String JavaDoc ALIAS_NAME_SPACE_FUNCTION_AS_STRING = "F";
59     public static final String JavaDoc ALIAS_NAME_SPACE_SYNONYM_AS_STRING = "S";
60
61     /**
62      * Get the name of the static method that the alias
63      * represents at the source database. (Only meaningful for
64      * method aliases )
65      *
66      * @return The name of the static method that the alias
67      * represents at the source database.
68      */
69     public String JavaDoc getMethodName();
70 }
71
Popular Tags