KeyRef (Castor JavaDoc)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.exolab.castor.xml.schema.Structure
- - org.exolab.castor.xml.schema.Annotated
  - - org.exolab.castor.xml.schema.IdentityConstraint
    - - org.exolab.castor.xml.schema.KeyRef

All Implemented Interfaces:

java.io.Serializable
```
public class KeyRef
extends IdentityConstraint
```
A class that represents the XML Schema Identity Constraint: KeyRef.

Version:

$Revision: 6230 $ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $

Author:

Keith Visco

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.exolab.castor.xml.schema.Structure
  ANNOTATION, ANYTYPE, APPINFO, ATTRIBUTE, ATTRIBUTE_GROUP, COMPLEX_CONTENT, COMPLEX_TYPE, DOCUMENTATION, ELEMENT, FACET, GROUP, IDENTITY_FIELD, IDENTITY_SELECTOR, KEY, KEYREF, LIST, MODELGROUP, MODELGROUP_REF, REDEFINE, SCHEMA, SIMPLE_CONTENT, SIMPLE_TYPE, UNION, UNIQUE, UNKNOWN, WILDCARD

Constructor Summary

Constructors
Constructor Description

KeyRef(java.lang.String name, java.lang.String refer)
Creates a new KeyRef Identity-Constraint.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getRefer()`	Returns the refer field (the name of the key being referenced).
`short`	`getStructureType()`	Returns the type of this Schema Structure.
`void`	`setRefer(java.lang.String refer)`	Sets the refer field (the name of the key being referenced).

Methods inherited from class org.exolab.castor.xml.schema.Annotated
addAnnotation, getAnnotations, removeAnnotation

Methods inherited from class org.exolab.castor.xml.schema.IdentityConstraint
addField, getFields, getId, getName, getSelector, removeField, setId, setName, setSelector, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class org.exolab.castor.xml.schema.Structure
isValid

- Constructor Detail
  - KeyRef
```
public KeyRef(java.lang.String name,
              java.lang.String refer)
       throws SchemaException
```
    Creates a new KeyRef Identity-Constraint.
    
    Parameters:
    
    name - the name for the IdentityConstraint. Must not be null.
    
    Throws:
    
    SchemaException - when name or refer are null.
- Method Detail
  - getRefer
```
public java.lang.String getRefer()
```
    Returns the refer field (the name of the key being referenced).
    
    Returns:
    
    the refer field (the name of the key being referenced).
  - setRefer
```
public void setRefer(java.lang.String refer)
              throws SchemaException
```
    Sets the refer field (the name of the key being referenced).
    
    Parameters:
    
    refer - the name of the key to reference. Must not be null.
    
    Throws:
    
    SchemaException - when refer is null.
  - getStructureType
```
public short getStructureType()
```
    Returns the type of this Schema Structure.
    
    Specified by:
    
    getStructureType in class IdentityConstraint
    
    Returns:
    
    the type of this Schema Structure.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Intalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com