|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jpox.metadata.MetaData
org.jpox.metadata.ExtendableMetaData
org.jpox.metadata.FileMetaData
Representation of a Meta-Data file. Contains a list of package meta-data.
Field Summary | |
protected java.lang.String |
catalog
Catalog name for all classes in this file |
protected java.lang.String |
filename
Name of file |
static int |
JDO_FILE
jdo file |
static int |
JDOQUERY_FILE
jdoquery file |
protected MetaDataManager |
metaDataManager
Manager for this MetaData object. |
static int |
ORM_FILE
orm file |
protected java.util.List |
packages
list of packages |
protected java.util.List |
queries
List of named queries |
protected java.lang.String |
schema
Schema name for all classes in this file |
protected int |
type
Type of file (JDO, ORM, JDOQUERY, etc) |
Fields inherited from class org.jpox.metadata.ExtendableMetaData |
extensions, JPOX_VENDOR_NAME |
Fields inherited from class org.jpox.metadata.MetaData |
LOCALISER, METADATA_CREATED_STATE, METADATA_INITIALISED_STATE, METADATA_POPULATED_STATE, METADATA_USED_STATE, metaDataState, parent |
Constructor Summary | |
FileMetaData(java.lang.String filename,
MetaDataManager metaDataManager,
java.lang.String catalog,
java.lang.String schema)
Constructor. |
Method Summary | |
void |
addPackage(PackageMetaData pkg)
Method to add a package |
void |
addQuery(QueryMetaData qmd)
Method to add a named query to this class. |
java.lang.String |
getCatalog()
Accessor for the catalog name for all classes in this file |
ClassMetaData |
getClass(java.lang.String pkg_name,
java.lang.String class_name)
Utility method to check if the MetaData for a class is contained in this file. |
java.lang.String |
getFilename()
Accessor for the filename |
MetaDataManager |
getMetaDataManager()
Accessor for the MetaDataManager for this file. |
int |
getNoOfPackages()
Accessor for the number of packages. |
int |
getNoOfQueries()
Accessor for the number of named queries. |
PackageMetaData |
getPackage(int i)
Accessor for the meta-data of a package. |
PackageMetaData |
getPackage(java.lang.String name)
Accessor for the Meta-Data of a package with a given name. |
QueryMetaData |
getQuery(int index)
Accessor for the metadata of a named query. |
java.lang.String |
getSchema()
Accessor for the schema name for all classes in this file |
int |
getType()
Accessor for the file type (JDO, ORM, etc) |
void |
mergeORMData(FileMetaData filemd)
Method to merge in the associated metadata from the ORM definition |
void |
setCatalog(java.lang.String catalog)
Mutator for the catalog for all classes in this file |
void |
setFilename(java.lang.String filename)
Mutator for the filename for this MetaData file. |
void |
setSchema(java.lang.String schema)
Mutator for the schema for all classes in this file |
void |
setType(int type)
Mutator for the file type. |
java.lang.String |
toString()
Returns a string representation of the object. |
java.lang.String |
toString(java.lang.String indent)
Returns a string representation of the object. |
Methods inherited from class org.jpox.metadata.ExtendableMetaData |
addExtension, addExtension, getExtension, getExtensions, getNoOfExtensions, getValueForExtension, getValuesForExtension, getValuesForExtensionStartingWith, hasExtension, removeExtension, toString |
Methods inherited from class org.jpox.metadata.MetaData |
getParent, initialise, isCreated, isInitialised, isPopulated, isUsed, populate, setInitialised, setPopulated, setUsed |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int JDO_FILE
public static final int ORM_FILE
public static final int JDOQUERY_FILE
protected final transient MetaDataManager metaDataManager
protected int type
protected java.lang.String filename
protected java.lang.String catalog
protected java.lang.String schema
protected java.util.List queries
protected java.util.List packages
Constructor Detail |
public FileMetaData(java.lang.String filename, MetaDataManager metaDataManager, java.lang.String catalog, java.lang.String schema)
filename
- The file where this is stored (or null).metaDataManager
- the manager for this MetaData object.catalog
- Name of the catalog for all classes in this fileschema
- Name of the schema for all classes in this fileMethod Detail |
public void mergeORMData(FileMetaData filemd)
filemd
- The FileMetaData definitionpublic int getType()
public int getNoOfQueries()
public QueryMetaData getQuery(int index)
index
- query index
public MetaDataManager getMetaDataManager()
public java.lang.String getFilename()
public java.lang.String getCatalog()
public java.lang.String getSchema()
public int getNoOfPackages()
public PackageMetaData getPackage(int i)
i
- index number
public PackageMetaData getPackage(java.lang.String name)
name
- Name of the package
public ClassMetaData getClass(java.lang.String pkg_name, java.lang.String class_name)
pkg_name
- Name of packageclass_name
- Name of class
public void setType(int type)
type
- The file typepublic void addQuery(QueryMetaData qmd)
qmd
- Meta-Data for the query.public void setFilename(java.lang.String filename)
filename
- The filename of this MetaData file.public void setCatalog(java.lang.String catalog)
catalog
- Catalog name to usepublic void setSchema(java.lang.String schema)
schema
- Schema name to usepublic void addPackage(PackageMetaData pkg)
pkg
- The PackageMetaData to add.public java.lang.String toString()
toString
in class ExtendableMetaData
public java.lang.String toString(java.lang.String indent)
indent
- The indent
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |