aoqi@0: /*
aoqi@0: * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
aoqi@0: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0: *
aoqi@0: * This code is free software; you can redistribute it and/or modify it
aoqi@0: * under the terms of the GNU General Public License version 2 only, as
aoqi@0: * published by the Free Software Foundation. Oracle designates this
aoqi@0: * particular file as subject to the "Classpath" exception as provided
aoqi@0: * by Oracle in the LICENSE file that accompanied this code.
aoqi@0: *
aoqi@0: * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0: * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0: * accompanied this code).
aoqi@0: *
aoqi@0: * You should have received a copy of the GNU General Public License version
aoqi@0: * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0: *
aoqi@0: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0: * or visit www.oracle.com if you need additional information or have any
aoqi@0: * questions.
aoqi@0: */
aoqi@0:
aoqi@0: package com.sun.xml.internal.xsom;
aoqi@0:
aoqi@0: import java.util.List;
aoqi@0:
aoqi@0: /**
aoqi@0: * Identity constraint.
aoqi@0: *
aoqi@0: * @author Kohsuke Kawaguchi
aoqi@0: */
aoqi@0: public interface XSIdentityConstraint extends XSComponent {
aoqi@0:
aoqi@0: /**
aoqi@0: * Gets the {@link XSElementDecl} that owns this identity constraint.
aoqi@0: *
aoqi@0: * @return
aoqi@0: * never null.
aoqi@0: */
aoqi@0: XSElementDecl getParent();
aoqi@0:
aoqi@0: /**
aoqi@0: * Name of the identity constraint.
aoqi@0: *
aoqi@0: * A name uniquely identifies this {@link XSIdentityConstraint} within
aoqi@0: * the namespace.
aoqi@0: *
aoqi@0: * @return
aoqi@0: * never null.
aoqi@0: */
aoqi@0: String getName();
aoqi@0:
aoqi@0: /**
aoqi@0: * Target namespace of the identity constraint.
aoqi@0: *
aoqi@0: * Just short for getParent().getTargetNamespace()
.
aoqi@0: */
aoqi@0: String getTargetNamespace();
aoqi@0:
aoqi@0: /**
aoqi@0: * Returns the type of the identity constraint.
aoqi@0: *
aoqi@0: * @return
aoqi@0: * either {@link #KEY},{@link #KEYREF}, or {@link #UNIQUE}.
aoqi@0: */
aoqi@0: short getCategory();
aoqi@0:
aoqi@0: final short KEY = 0;
aoqi@0: final short KEYREF = 1;
aoqi@0: final short UNIQUE = 2;
aoqi@0:
aoqi@0: /**
aoqi@0: * Returns the selector XPath expression as string.
aoqi@0: *
aoqi@0: * @return
aoqi@0: * never null.
aoqi@0: */
aoqi@0: XSXPath getSelector();
aoqi@0:
aoqi@0: /**
aoqi@0: * Returns the list of field XPaths.
aoqi@0: *
aoqi@0: * @return
aoqi@0: * a non-empty read-only list of {@link String}s,
aoqi@0: * each representing the XPath.
aoqi@0: */
aoqi@0: List getFields();
aoqi@0:
aoqi@0: /**
aoqi@0: * If this is {@link #KEYREF}, returns the key {@link XSIdentityConstraint}
aoqi@0: * being referenced.
aoqi@0: *
aoqi@0: * @return
aoqi@0: * always non-null (when {@link #getCategory()}=={@link #KEYREF}).
aoqi@0: * @throws IllegalStateException
aoqi@0: * if {@link #getCategory()}!={@link #KEYREF}
aoqi@0: */
aoqi@0: XSIdentityConstraint getReferencedKey();
aoqi@0: }