com.sun.xml.xsom.XSIdentityConstraint Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.xsom;
import java.util.List;
/**
* Identity constraint.
*
* @author Kohsuke Kawaguchi
*/
public interface XSIdentityConstraint extends XSComponent {
/**
* Gets the {@link XSElementDecl} that owns this identity constraint.
*
* @return
* never null.
*/
XSElementDecl getParent();
/**
* Name of the identity constraint.
*
* A name uniquely identifies this {@link XSIdentityConstraint} within
* the namespace.
*
* @return
* never null.
*/
String getName();
/**
* Target namespace of the identity constraint.
*
* Just short for getParent().getTargetNamespace().
*/
String getTargetNamespace();
/**
* Returns the type of the identity constraint.
*
* @return
* either {@link #KEY},{@link #KEYREF}, or {@link #UNIQUE}.
*/
short getCategory();
final short KEY = 0;
final short KEYREF = 1;
final short UNIQUE = 2;
/**
* Returns the selector XPath expression as string.
*
* @return
* never null.
*/
XSXPath getSelector();
/**
* Returns the list of field XPaths.
*
* @return
* a non-empty read-only list of {@link String}s,
* each representing the XPath.
*/
List getFields();
/**
* If this is {@link #KEYREF}, returns the key {@link XSIdentityConstraint}
* being referenced.
*
* @return
* always non-null (when {@link #getCategory()}=={@link #KEYREF}).
* @throws IllegalStateException
* if {@link #getCategory()}!={@link #KEYREF}
*/
XSIdentityConstraint getReferencedKey();
}