Class FileMetaData

java.lang.Object
org.datanucleus.metadata.MetaData
org.datanucleus.metadata.FileMetaData
All Implemented Interfaces:
Serializable

public class FileMetaData extends MetaData
Representation of a Meta-Data file. Contains a list of package meta-data, together with any named queries and fetch plans etc.
See Also:
  • Field Details

  • Constructor Details

    • FileMetaData

      public FileMetaData()
    • FileMetaData

      public FileMetaData(String filename)
  • Method Details

    • getFilename

      public String getFilename()
    • setFilename

      public FileMetaData setFilename(String filename)
    • getCatalog

      public String getCatalog()
    • setCatalog

      public FileMetaData setCatalog(String catalog)
    • getSchema

      public String getSchema()
    • setSchema

      public FileMetaData setSchema(String schema)
    • getType

      public MetaDataFileType getType()
    • setType

      public FileMetaData setType(MetaDataFileType type)
    • getNoOfQueries

      public int getNoOfQueries()
      Accessor for the number of named queries.
      Returns:
      no of named queries
    • getQueries

      public QueryMetaData[] getQueries()
      Accessor for the metadata of the named queries.
      Returns:
      Meta-Data for the named queries.
    • getNoOfStoredProcQueries

      public int getNoOfStoredProcQueries()
      Accessor for the number of named queries.
      Returns:
      no of named queries
    • getStoredProcQueries

      public StoredProcQueryMetaData[] getStoredProcQueries()
      Accessor for the metadata of the named stored procedure queries.
      Returns:
      Meta-Data for the named stored proc queries.
    • getNoOfFetchPlans

      public int getNoOfFetchPlans()
      Accessor for the number of named fetch plans.
      Returns:
      no of named fetch plans
    • getFetchPlans

      public FetchPlanMetaData[] getFetchPlans()
      Accessor for the metadata of the named fetch plans.
      Returns:
      Meta-Data for the named fetch plans.
    • getNoOfPackages

      public int getNoOfPackages()
      Accessor for the number of packages.
      Returns:
      no of packages.
    • getPackage

      public PackageMetaData getPackage(int i)
      Accessor for the meta-data of a package.
      Parameters:
      i - index number
      Returns:
      Meta-Data for a package.
    • getPackage

      public PackageMetaData getPackage(String name)
      Accessor for the Meta-Data of a package with a given name.
      Parameters:
      name - Name of the package
      Returns:
      Meta-Data for the package
    • getClass

      public ClassMetaData getClass(String pkg_name, String class_name)
      Utility method to check if the MetaData for a class is contained in this file.
      Parameters:
      pkg_name - Name of package
      class_name - Name of class
      Returns:
      The MetaData for the class
    • newQueryMetaData

      public QueryMetaData newQueryMetaData(String queryName)
      Method to create a new QueryMetadata, add it to the registered queries and return it.
      Parameters:
      queryName - Name of the query
      Returns:
      The Query metadata
    • newStoredProcQueryMetaData

      public StoredProcQueryMetaData newStoredProcQueryMetaData(String queryName)
      Method to create a new StoredProcQueryMetadata, add it to the registered queries and return it.
      Parameters:
      queryName - Name of the query
      Returns:
      The Query metadata
    • newFetchPlanMetaData

      public FetchPlanMetaData newFetchPlanMetaData(String name)
    • newPackageMetaData

      public PackageMetaData newPackageMetaData(String name)
      Method to create and return a package metadata for the specified package name.
      Parameters:
      name - Name of the package
      Returns:
      The PackageMetadata
    • addListener

      public void addListener(EventListenerMetaData listener)
      Add a listener class name
      Parameters:
      listener - the listener metadata. Duplicated classes are ignored
    • getListeners

      public List<EventListenerMetaData> getListeners()
      Get the event listeners registered against the file.
      Returns:
      the event listeners
    • addQueryResultMetaData

      public void addQueryResultMetaData(QueryResultMetaData resultMetaData)
      Method to register a query-result MetaData.
      Parameters:
      resultMetaData - Query-Result MetaData to register
    • newQueryResultMetaData

      public QueryResultMetaData newQueryResultMetaData(String name)
      Method to create a new query result metadata, add it, and return it.
      Parameters:
      name - Name of the result
      Returns:
      The query result metadata
    • getQueryResultMetaData

      public QueryResultMetaData[] getQueryResultMetaData()
      Get the query result MetaData.
      Returns:
      Query Result MetaData