Adding JMCR-Stable version
[Benchmarks_CSolver.git] / JMCR-Stable / real-world application / derby-10.3.2.1 / java / engine / org / apache / derby / iapi / types / CollationElementsInterface.java
diff --git a/JMCR-Stable/real-world application/derby-10.3.2.1/java/engine/org/apache/derby/iapi/types/CollationElementsInterface.java b/JMCR-Stable/real-world application/derby-10.3.2.1/java/engine/org/apache/derby/iapi/types/CollationElementsInterface.java
new file mode 100644 (file)
index 0000000..0bb2161
--- /dev/null
@@ -0,0 +1,52 @@
+/*\r
+\r
+   Derby - Class org.apache.derby.iapi.types.CollationElementsInterface\r
\r
+   Licensed to the Apache Software Foundation (ASF) under one or more\r
+   contributor license agreements.  See the NOTICE file distributed with\r
+   this work for additional information regarding copyright ownership.\r
+   The ASF licenses this file to you under the Apache License, Version 2.0\r
+   (the "License"); you may not use this file except in compliance with\r
+   the License.  You may obtain a copy of the License at\r
+\r
+      http://www.apache.org/licenses/LICENSE-2.0\r
+\r
+   Unless required by applicable law or agreed to in writing, software\r
+   distributed under the License is distributed on an "AS IS" BASIS,\r
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+   See the License for the specific language governing permissions and\r
+   limitations under the License.\r
+\r
+ */\r
+\r
+package org.apache.derby.iapi.types;\r
+\r
+import org.apache.derby.iapi.error.StandardException;\r
+\r
+/**\r
+ * CollationElementsInterface is an interface which will be implemented by  \r
+ * all the Collator sensitive char data types. These methods will be called by \r
+ * WorkHorseForCollatorDatatypes's collation sensitive methods \r
+ * "like, stringcompare" etc.  \r
+ */\r
+interface CollationElementsInterface\r
+{\r
+       /**\r
+        * This method translates the string into a series of collation elements.\r
+        * These elements will get used in the like method.\r
+        * \r
+        * @return an array of collation elements for the string\r
+        * @throws StandardException\r
+        */\r
+       public int[] getCollationElementsForString() throws StandardException; \r
+\r
+       /**\r
+        * This method returns the count of collation elements for this instance of\r
+        * CollationElementsInterface. This method will return the correct value only if  \r
+        * method getCollationElementsForString has been called previously on this \r
+        * instance of CollationElementsInterface. \r
+        *\r
+        * @return count of collation elements for this instance of CollatorSQLChar\r
+        */\r
+       public int getCountOfCollationElements();\r
+}\r