org.exolab.castor.builder

Class GroupInfo

public class GroupInfo extends Object

A class to hold group information

Version: $Revision: 6302 $ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $

Author: Keith Visco

Field Summary
static intALL
The compositor value that indicates that all fields are required, but order is not important.
static intCHOICE
The compositor value that indicates that only one field may be present.
static intSEQUENCE
The compositor value that indicates that all fields are required and order is important.
Constructor Summary
GroupInfo()
Creates a new GroupInfo.
Method Summary
intgetMaxOccurs()
Returns the maximum occurance for this group.
intgetMinOccurs()
Returns the minimum occurance for this group.
booleanisChoice()
Returns true if the compositor of this GroupInfo is a choice.
booleanisMultivalued()
Return whether or not the object described by this XMLInfo is multi-valued (appears more than once in the XML document).
booleanisRequired()
Return true if the XML object described by this GroupInfo must appear at least once in the XML document (or object model).
booleanisSequence()
Returns true if the compositor of this GroupInfo is a sequence.
voidsetAsAll()
Sets the compositor for the fields of this group to be "all".
voidsetAsChoice()
Sets the compositor for the fields of this group to be a choice.
voidsetAsSequence()
Sets the compositor for the fields of this group to be a sequence.
voidsetMaxOccurs(int maxOccurs)
Sets the maximum occurance for this group.
voidsetMinOccurs(int minOccurs)
Sets the minimum occurance for this group.
voidsetMultivalued(boolean multivalued)
Sets whether the XML object can appear more than once in the XML document.
voidsetRequired(boolean required)
Sets whether or not the XML object must appear at least once.

Field Detail

ALL

public static final int ALL
The compositor value that indicates that all fields are required, but order is not important. default

CHOICE

public static final int CHOICE
The compositor value that indicates that only one field may be present.

SEQUENCE

public static final int SEQUENCE
The compositor value that indicates that all fields are required and order is important.

Constructor Detail

GroupInfo

public GroupInfo()
Creates a new GroupInfo.

Method Detail

getMaxOccurs

public int getMaxOccurs()
Returns the maximum occurance for this group.

Returns: the maximum occurance for this group.

getMinOccurs

public int getMinOccurs()
Returns the minimum occurance for this group.

Returns: the minimum occurance for this group.

isChoice

public boolean isChoice()
Returns true if the compositor of this GroupInfo is a choice.

Returns: true if the compositor of this GroupInfo is a choice.

isMultivalued

public boolean isMultivalued()
Return whether or not the object described by this XMLInfo is multi-valued (appears more than once in the XML document).

Returns: true if this object can appear more than once.

isRequired

public boolean isRequired()
Return true if the XML object described by this GroupInfo must appear at least once in the XML document (or object model).

Returns: true if the XML object must appear at least once.

isSequence

public boolean isSequence()
Returns true if the compositor of this GroupInfo is a sequence.

Returns: true if the compositor of this GroupInfo is a sequence.

setAsAll

public void setAsAll()
Sets the compositor for the fields of this group to be "all".

setAsChoice

public void setAsChoice()
Sets the compositor for the fields of this group to be a choice.

setAsSequence

public void setAsSequence()
Sets the compositor for the fields of this group to be a sequence.

setMaxOccurs

public void setMaxOccurs(int maxOccurs)
Sets the maximum occurance for this group.

Parameters: maxOccurs the maximum occurance this group must appear

setMinOccurs

public void setMinOccurs(int minOccurs)
Sets the minimum occurance for this group.

Parameters: minOccurs the minimum occurance this group must appear

setMultivalued

public void setMultivalued(boolean multivalued)
Sets whether the XML object can appear more than once in the XML document.

Parameters: multivalued the boolean indicating whether or not the object can appear more than once

setRequired

public void setRequired(boolean required)
Sets whether or not the XML object must appear at least once.

Parameters: required the flag indicating whether or not this XML object is required

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