FileDocCategorySizeDatePackage
FieldGroupElement.javaAPI DocGlassfish v2 API6428Fri May 04 22:34:42 BST 2007com.sun.jdo.api.persistence.model.jdo

FieldGroupElement

public abstract class FieldGroupElement extends PersistenceMemberElement implements FieldElementHolder
author
raccah
version
%I%

Fields Summary
Constructors Summary
public FieldGroupElement()
Create new FieldGroupElement with no implementation. This constructor should only be used for cloning and archiving.

		this(null, null);
	
public FieldGroupElement(Impl impl, PersistenceClassElement declaringClass)
Create new FieldGroupElement with the provided implementation. The implementation is responsible for storing all properties of the object.

param
impl the implementation to use
param
declaringClass the class to attach to

		super(impl, declaringClass);
	
Methods Summary
public voidaddField(PersistenceFieldElement field)
Add the supplied field to the collection of fields maintained by this holder.

param
field the field to be added
exception
ModelException if impossible

		addFields(new PersistenceFieldElement[]{field});
	
public voidaddFields(PersistenceFieldElement[] fields)
Add the supplied fields to the collection of fields maintained by this holder.

param
fields the array of fields to be added
exception
ModelException if impossible

		getFieldGroupImpl().changeFields(fields, Impl.ADD);
	
public booleancontainsField(PersistenceFieldElement field)
Tests whether the supplied field is in the collection of fields maintained by this holder.

param
field the field to be tested

		return (getFieldGroupImpl().getField(field.getName()) != null);
	
public PersistenceFieldElementgetField(java.lang.String name)
Returns the field with the supplied name from the collection of fields maintained by this holder.

param
name the name of the field to be found
return
the field with the supplied name, null if none exists

		return getFieldGroupImpl().getField(name);
	
final com.sun.jdo.api.persistence.model.jdo.FieldGroupElement$ImplgetFieldGroupImpl()

return
implemetation factory for this field group

 return (Impl)getImpl(); 
public PersistenceFieldElement[]getFields()
Returns the collection of fields maintained by this holder in the form of an array.

return
the fields maintained by this holder

		return getFieldGroupImpl().getFields();
	
public voidremoveField(PersistenceFieldElement field)
Remove the supplied field from the collection of fields maintained by this holder.

param
field the field to be removed
exception
ModelException if impossible

		removeFields(new PersistenceFieldElement[]{field});
	
public voidremoveFields(PersistenceFieldElement[] fields)
Removed the supplied fields from the collection of fields maintained by this holder.

param
fields the array of fields to be removed
exception
ModelException if impossible

		getFieldGroupImpl().changeFields(fields, Impl.REMOVE);
	
public voidsetFields(PersistenceFieldElement[] fields)
Sets the collection of fields maintained by this holder to the contents of the supplied array.

param
fields the fields maintained by this holder
exception
ModelException if impossible

		getFieldGroupImpl().changeFields(fields, Impl.SET);