Copyright (c) 2005 Andy Jefferson and others. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

Contributors:

    ...

**********************************************************************/

* Abstract representation of the MetaData of a class/interface.

* Has a parent PackageMetaData that can contain the metadata for several classes/interfaces.

* Is extended by ClassMetaData and InterfaceMetaData.

* Of the things that it contains the main one are the "members" which are the MetaData for

* all fields and properties that are persistable.

*/

    protected static final Localiser LOCALISER_API=Localiser.getInstance("org.datanucleus.Localisation",

        ObjectManagerImpl.class.getClassLoader());

    /** Suffix to add on to the class name for any generated primary key class. */

    public static final String GENERATED_PK_SUFFIX = "_PK";

    /** Class name */

    protected final String name;

    /** Entity name. Required by JPA1 $4.3.1 for accessing this class in queries. */

    protected String entityName;

    /** Whether the user can persist instances of this class. Will be false if using "MappedSuperclass". */

    protected boolean instantiable = true;

    /** Identity-type tag value. */

    protected IdentityType identityType = IdentityType.DATASTORE;

    /** persistence-modifier tag value. */

    protected ClassPersistenceModifier persistenceModifier = ClassPersistenceModifier.PERSISTENCE_CAPABLE;

    /** persistable-superclass tag value (deprecated). */

    protected String persistableSuperclass;

    /** objectid-class tag value. */

    protected String objectidClass;

    /** requires-extent tag value. */

    protected boolean requiresExtent = true;

    /** detachable tag value. */

    protected boolean detachable = false;

    /** embedded-only tag value. */

    protected boolean embeddedOnly = false;

    /** Catalog name (O/R mapping). */

    protected String catalog;

    /** Schema name (O/R mapping). */

    protected String schema;

    /** Table name (O/R mapping). This may be of the form "[database].[catalog].[schema].table" */

    protected String table;

    /** cacheable tag value. */

    protected boolean cacheable = true;

    /** Full name (e.g org.datanucleus.MyClass) */

    protected final String fullName;

    /** Version MetaData */

    protected VersionMetaData versionMetaData;

    /** Identity MetaData */

    protected IdentityMetaData identityMetaData;

    /** Flag whether the identity was specified by the user. */

    protected boolean identitySpecified = false;

    /** Inheritance MetaData */

    protected InheritanceMetaData inheritanceMetaData;

    /** PrimaryKey MetaData */

    protected PrimaryKeyMetaData primaryKeyMetaData;

    /** EventListeners. Use a list to preserve ordering. */

    protected List listeners = null;

    /** Flag to exclude superclass listeners. */

    protected Boolean excludeSuperClassListeners = null;

    /** Flag to exclude default listeners. */

    protected Boolean excludeDefaultListeners = null;

    /** Fetch Groups for this class. Available to be used in queries and when detaching. */

    protected FetchGroupMetaData[] fetchGroupMetaData;

    /** Convenience lookup map of fetch group by the name. */

    protected Map<String, FetchGroupMetaData> fetchGroupMetaDataByName;

    /** Class MetaData for the persistable superclass (if any) */

    protected AbstractClassMetaData pcSuperclassMetaData = null;

    /** Flag for whether the MetaData here is complete without annotations. Used by JPA. */

    protected boolean metaDataComplete = false;

    /** Whether to lock objects of this type on read operations. */

    protected boolean serializeRead = false;

    /** Named queries */

    protected Collection<QueryMetaData> queries = null;

    /** List of query result MetaData defined for this file. */

    protected Collection<QueryResultMetaData> queryResultMetaData = null;

    /** JoinMetaData */

    protected JoinMetaData[] joinMetaData;

    /** IndexMetaData */

    protected IndexMetaData[] indexMetaData;

    /** ForeignKeyMetaData */

    protected ForeignKeyMetaData[] foreignKeyMetaData;

    /** UniqueMetaData */

    protected UniqueMetaData[] uniqueMetaData;

    /** List of members (fields/properties). */

    protected List members = new ArrayList();

    /** The columns that are present in the datastore yet not mapped to fields in this class. */

    protected List<ColumnMetaData> unmappedColumns = null;

    // These fields are only used when the MetaData is read by the parser and elements are dynamically added to

    // the other elements. At initialise() they are cleared and nulled so shouldn't be used internally.

    /** List of joins */

    protected List<JoinMetaData> joins = new ArrayList();

    /** List of foreign-key */

    protected List<ForeignKeyMetaData> foreignKeys = new ArrayList();