com.sun.jdo.api.persistence.model.jdo.FieldGroupElement Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/*
* FieldGroupElement.java
*
* Created on February 29, 2000, 4:57 PM
*/
package com.sun.jdo.api.persistence.model.jdo;
import com.sun.jdo.api.persistence.model.ModelException;
/**
*
* @author raccah
* @version %I%
*/
public abstract class FieldGroupElement extends PersistenceMemberElement
implements FieldElementHolder
{
/** Create new FieldGroupElement with no implementation.
* This constructor should only be used for cloning and archiving.
*/
public FieldGroupElement ()
{
this(null, null);
}
/** 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
*/
public FieldGroupElement (FieldGroupElement.Impl impl,
PersistenceClassElement declaringClass)
{
super(impl, declaringClass);
}
/** @return implemetation factory for this field group
*/
final Impl getFieldGroupImpl () { return (Impl)getImpl(); }
//================== Fields ===============================
// PersistenceFieldElement handling, implementation of FieldElementHolder
/** Add the supplied field to the collection of fields maintained by this
* holder.
* @param field the field to be added
* @exception ModelException if impossible
*/
public void addField (PersistenceFieldElement field)
throws ModelException
{
addFields(new PersistenceFieldElement[]{field});
}
/** 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
*/
public void addFields(PersistenceFieldElement[] fields)
throws ModelException
{
getFieldGroupImpl().changeFields(fields, Impl.ADD);
}
/** Remove the supplied field from the collection of fields maintained by
* this holder.
* @param field the field to be removed
* @exception ModelException if impossible
*/
public void removeField (PersistenceFieldElement field)
throws ModelException
{
removeFields(new PersistenceFieldElement[]{field});
}
/** 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
*/
public void removeFields (PersistenceFieldElement[] fields)
throws ModelException
{
getFieldGroupImpl().changeFields(fields, Impl.REMOVE);
}
/** Returns the collection of fields maintained by this holder in the form
* of an array.
* @return the fields maintained by this holder
*/
public PersistenceFieldElement[] getFields ()
{
return getFieldGroupImpl().getFields();
}
/** 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
*/
public void setFields (PersistenceFieldElement[] fields)
throws ModelException
{
getFieldGroupImpl().changeFields(fields, Impl.SET);
}
/** 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
*/
public PersistenceFieldElement getField (String name)
{
return getFieldGroupImpl().getField(name);
}
/** Tests whether the supplied field is in the collection of fields
* maintained by this holder.
* @param field the field to be tested
*/
public boolean containsField (PersistenceFieldElement field)
{
return (getFieldGroupImpl().getField(field.getName()) != null);
}
/** Pluggable implementation of the storage of field element properties.
* @see PersistenceFieldElement#PersistenceFieldElement
*/
public interface Impl extends PersistenceMemberElement.Impl
{
/** Change the set of fields.
* @param fields the new fields
* @param action {@link #ADD}, {@link #REMOVE}, or {@link #SET}
* @exception ModelException if impossible
*/
public void changeFields (PersistenceFieldElement[] fields, int action)
throws ModelException;
/** Get all fields.
* @return the fields
*/
public PersistenceFieldElement[] getFields ();
/** Find a field by name.
* @param name the name to match
* @return the field, or null if it does not exist
*/
public PersistenceFieldElement getField (String name);
}
}