com.sun.xml.xsom.XSIdentityConstraint Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2022 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
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 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();
short KEY = 0;
short KEYREF = 1;
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
* being referenced.
*
* @return
* always non-null (when {@link #getCategory()}=={@link #KEYREF}).
* @throws IllegalStateException
* if {@link #getCategory()}!={@link #KEYREF}
*/
XSIdentityConstraint getReferencedKey();
}