Package com.sun.xml.xsom

Interface XSIdentityConstraint

All Superinterfaces:

XSComponent

All Known Implementing Classes:

IdentityConstraintImpl

public interface XSIdentityConstraint
extends XSComponent

Identity constraint.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field	Description
static final short	KEY
static final short	KEYREF
static final short	UNIQUE

Method Summary

Modifier and Type	Method	Description
short	getCategory()	Returns the type of the identity constraint.
List<XSXPath>	getFields()	Returns the list of field XPaths.
String	getName()	Name of the identity constraint.
XSElementDecl	getParent()	Gets the XSElementDecl that owns this identity constraint.
XSIdentityConstraint	getReferencedKey()	If this is KEYREF, returns the key being referenced.
XSXPath	getSelector()	Returns the selector XPath expression as string.
String	getTargetNamespace()	Target namespace of the identity constraint.

Methods inherited from interface com.sun.xml.xsom.XSComponent

apply, getAnnotation, getAnnotation, getForeignAttribute, getForeignAttributes, getLocator, getOwnerSchema, getRoot, getSourceDocument, select, selectSingle, visit

Field Details

KEY

static final short KEY

See Also:

• Constant Field Values

KEYREF

static final short KEYREF

See Also:

• Constant Field Values

UNIQUE

static final short UNIQUE

See Also:

• Constant Field Values

Method Details

getParent

XSElementDecl getParent()

Gets the XSElementDecl that owns this identity constraint.

Returns:

never null.

getName

String getName()

Name of the identity constraint. A name uniquely identifies this within the namespace.

Returns:

never null.

getTargetNamespace

String getTargetNamespace()

Target namespace of the identity constraint. Just short for getParent().getTargetNamespace().

getCategory

short getCategory()

Returns the type of the identity constraint.

Returns:

either KEY,KEYREF, or UNIQUE.

getSelector

XSXPath getSelector()

Returns the selector XPath expression as string.

Returns:

never null.

getFields

List<XSXPath> getFields()

Returns the list of field XPaths.

Returns:

a non-empty read-only list of Strings, each representing the XPath.

getReferencedKey

XSIdentityConstraint getReferencedKey()

If this is KEYREF, returns the key being referenced.

Returns:

always non-null (when getCategory()==KEYREF).

Throws:

IllegalStateException - if getCategory()!=KEYREF