View Javadoc
1   /*
2    * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package com.sun.xml.internal.xsom;
27  
28  import java.util.List;
29  
30  /**
31   * Identity constraint.
32   *
33   * @author Kohsuke Kawaguchi
34   */
35  public interface XSIdentityConstraint extends XSComponent {
36  
37      /**
38       * Gets the {@link XSElementDecl} that owns this identity constraint.
39       *
40       * @return
41       *      never null.
42       */
43      XSElementDecl getParent();
44  
45      /**
46       * Name of the identity constraint.
47       *
48       * A name uniquely identifies this {@link XSIdentityConstraint} within
49       * the namespace.
50       *
51       * @return
52       *      never null.
53       */
54      String getName();
55  
56      /**
57       * Target namespace of the identity constraint.
58       *
59       * Just short for <code>getParent().getTargetNamespace()</code>.
60       */
61      String getTargetNamespace();
62  
63      /**
64       * Returns the type of the identity constraint.
65       *
66       * @return
67       *      either {@link #KEY},{@link #KEYREF}, or {@link #UNIQUE}.
68       */
69      short getCategory();
70  
71      final short KEY = 0;
72      final short KEYREF = 1;
73      final short UNIQUE = 2;
74  
75      /**
76       * Returns the selector XPath expression as string.
77       *
78       * @return
79       *      never null.
80       */
81      XSXPath getSelector();
82  
83      /**
84       * Returns the list of field XPaths.
85       *
86       * @return
87       *      a non-empty read-only list of {@link String}s,
88       *      each representing the XPath.
89       */
90      List<XSXPath> getFields();
91  
92      /**
93       * If this is {@link #KEYREF}, returns the key {@link XSIdentityConstraint}
94       * being referenced.
95       *
96       * @return
97       *      always non-null (when {@link #getCategory()}=={@link #KEYREF}).
98       * @throws IllegalStateException
99       *      if {@link #getCategory()}!={@link #KEYREF}
100      */
101     XSIdentityConstraint getReferencedKey();
102 }