EDMDataFactory

edm.edom3

Interface EDMDataFactory

• ---

  
  

  public interface EDMDataFactory

  
  The EDMFactory supplies methods for creating EDOM3 objects, and is the only place you can do so. To create your own subclasses of EDOM3 object you will need to override implementation of this class as well. We do notadvise you to such operations unless you are certain of what you are doing.

• • Method Summary

    All Methods Instance Methods Abstract Methods Deprecated Methods 

    Modifier and Type	Method and Description
    EDMAggregate	getAggregate(long id) Get an aggregate wrapper
    EDMDefinedType	getDefinedType(EDMExpressSchema schema, java.lang.String name) Get a wrapper for a defined type
    EDMDefinedType	getDefinedType(EDMModel model, java.lang.String name) Get a wrapper for a defined type
    EDMDefinedType	getDefinedType(long id) Get a wrapper for a defined type
    EDMGroup	getEDMGroup(long instanceId) Get an EDMGroup wrapper
    EDMGroup	getEDMGroup(java.lang.String name) Get an EDMGroup wrapper
    EDMUser	getEDMUser(long instanceId) Get an EDMUser wrapper
    EDMUser	getEDMUser(java.lang.String name) Get an EDMUser wrapper
    EDMUserOrGroup	getEDMUserOrGroup(long id) Get an EDMUserOrGroup wrapper based on instance id
    EDMExpressSchema	getExpressSchema(java.lang.String schemaName) Get an EXPRESS schema wrapper
    EDMFormalParameter	getFormalParameter(java.lang.String name, int type) Get a parameter wrapper
    EDMFileMapping	getInputFileMapping(java.io.File file, java.lang.String remoteName) Get a wrapper for a local file bound to input to EXPRESS-X execution.
    EDMLocalStream	getInputStream() Deprecated.  the stream interface is not implemented yet. Currently the stream wrapping is only wrapping local files. Use getLocalFile instead.
    EDMInstance	getInstance(long id) Get an instance wrapper
    EDMLocalStream	getLocalFile(java.io.File file) Get a wrapper for a local file
    EDMApplicationSchema	getMapSchema(java.lang.String schemaName) Get an EXPRESS-X schema map wrapper
    EDMModel	getModel(long modelId) Get a model wrapper
    EDMModel	getModel(java.lang.String repository, java.lang.String model) Get a model wrapper
    EDMFileMapping	getOutputFileMapping(java.io.File file, java.lang.String remoteName) Get a wrapper for a local file bound to output from EXPRESS-X execution.
    EDMQueryResult	getQueryResult() Get an empty QueryResult wrapper
    EDMApplicationSchema	getQuerySchema(java.lang.String name, EDMExpressSchema forSchema) Get a query schema
    EDMRepository	getRepository(long repositoryId) Get a repository wrapper
    EDMRepository	getRepository(java.lang.String repository) Get a repository wrapper
    EDMRow	getRow(long id) Get an EDMRow wrapper
    EDMApplicationSchema	getRuleSchema(java.lang.String name, EDMExpressSchema forSchema) Get a query schema
    EDMSelect	getSelect() Get an empty SELECT wrapper
    EDMInstance	getSystemShadow(EDMInstance ee) Get the shadow instance in system data model for a model,schema,...
    EDMRow	getXmlConfiguration(EDMExpressSchema schema, java.lang.String name) Create a new XmlConfiguration in this database.
    EDMGroup[]	listEDMGroups() Get all EDM groups
    EDMUser[]	listEDMUsers() Get all EDM groups
    EDMExpressSchema[]	listExpressSchemata() List all EXPRESS schemas in database
    EDMApplicationSchema[]	listMapSchemata() Return all the Schemas Maps in the database.
    EDMModel[]	listModels(java.lang.String repositoryName) List models in the database
    EDMRepository[]	listRepositories() List all repositories in the database
    EDMRow[]	listXmlConfigurations(EDMExpressSchema schema, java.lang.String filter) Returns all or some XmlConfigurations in this EDM Database.

• • Method Detail

    • getInputStream

      EDMLocalStream getInputStream()
                             throws EdmiException

      
      Deprecated. the stream interface is not implemented yet. Currently the stream wrapping is only wrapping local files. Use getLocalFile instead.
      Get a wrapper for piping from EDM to input stream

      Returns:a new wrapperThrows:EdmiException - if factory cannot be retrieved

    • getDefinedType

      EDMDefinedType getDefinedType(EDMExpressSchema schema,
                                    java.lang.String name)
                             throws EdmiException

      
      Get a wrapper for a defined type

      Parameters:schema - the schema where the defined type is definedname - name of defined typeReturns:a new wrapperThrows:EdmiException - if defined type cannot be created

    • getDefinedType

      EDMDefinedType getDefinedType(long id)
                             throws EdmiException

      
      Get a wrapper for a defined type

      Parameters:id - instance ID for defined type (meta-data)Returns:a new wrapperThrows:EdmiException - if defined type cannot be created

    • getDefinedType

      EDMDefinedType getDefinedType(EDMModel model,
                                    java.lang.String name)
                             throws EdmiException

      
      Get a wrapper for a defined type

      Parameters:model - model in which the defined type can be used (defined in underlying schema)name - name of defined typeReturns:a new wrapperThrows:EdmiException - if defined type cannot be created

    • getLocalFile

      EDMLocalStream getLocalFile(java.io.File file)
                           throws EdmiException

      
      Get a wrapper for a local file

      Parameters:file - Local file to useReturns:a new wrapperThrows:EdmiException - if factory cannot be retrieved

    • getInputFileMapping

      EDMFileMapping getInputFileMapping(java.io.File file,
                                         java.lang.String remoteName)
                                  throws EdmiException

      
      Get a wrapper for a local file bound to input to EXPRESS-X execution.

      Parameters:file - Local file to useremoteName - logical filename used in the EXPRESS-X schema (rule, query, map...)Returns:a new wrapperThrows:EdmiException - if factory cannot be retrieved

    • getOutputFileMapping

      EDMFileMapping getOutputFileMapping(java.io.File file,
                                          java.lang.String remoteName)
                                   throws EdmiException

      
      Get a wrapper for a local file bound to output from EXPRESS-X execution.

      Parameters:file - Local file to useremoteName - logical filename used in the EXPRESS-X schema (rule, query, map...)Returns:a new wrapperThrows:EdmiException - if factory cannot be retrieved

    • getFormalParameter

      EDMFormalParameter getFormalParameter(java.lang.String name,
                                            int type)
                                     throws EdmiException

      
      Get a parameter wrapper

      Parameters:name - name for the parametertype - type for the parameterReturns:a new wrapperThrows:EdmiException - if factory cannot be retrieved

    • getModel

      EDMModel getModel(java.lang.String repository,
                        java.lang.String model)
                 throws EdmiException

      
      Get a model wrapper

      Parameters:repository - Repository namemodel - Model nameReturns:a new wrapperThrows:EdmiException - if factory cannot be retrieved

    • getModel

      EDMModel getModel(long modelId)
                 throws EdmiException

      
      Get a model wrapper

      Parameters:modelId - instance idReturns:a new wrapperThrows:EdmiException - if factory cannot be retrieved

    • listModels

      EDMModel[] listModels(java.lang.String repositoryName)
                     throws EdmiException

      
      List models in the database

      Parameters:repositoryName - reposityory name filterReturns:array of EDMModelsThrows:EdmiException - if the method fails

    • getRepository

      EDMRepository getRepository(java.lang.String repository)
                           throws EdmiException

      
      Get a repository wrapper

      Parameters:repository - Repository nameReturns:a new wrapperThrows:EdmiException - if factory cannot be retrieved

    • getRepository

      EDMRepository getRepository(long repositoryId)
                           throws EdmiException

      
      Get a repository wrapper

      Parameters:repositoryId - instance idReturns:a new wrapperThrows:EdmiException - if the method fails

    • listRepositories

      EDMRepository[] listRepositories()
                                throws EdmiException

      
      List all repositories in the database

      Returns:array of SdaiRepositoriesThrows:EdmiException - if the method fails

    • getExpressSchema

      EDMExpressSchema getExpressSchema(java.lang.String schemaName)
                                 throws EdmiException

      
      Get an EXPRESS schema wrapper

      Parameters:schemaName - name for possible non-existant schemaReturns:a schema wrapperThrows:EdmiException - if the method fails

    • listExpressSchemata

      EDMExpressSchema[] listExpressSchemata()
                                      throws EdmiException

      
      List all EXPRESS schemas in database

      Returns:array of EDM schemataThrows:EdmiException - if the method fails

    • getMapSchema

      EDMApplicationSchema getMapSchema(java.lang.String schemaName)
                                 throws EdmiException

      
      Get an EXPRESS-X schema map wrapper

      Parameters:schemaName - name for possible non-existant schemaReturns:a schema wrapperThrows:EdmiException - if the method fails

    • listMapSchemata

      EDMApplicationSchema[] listMapSchemata()
                                      throws EdmiException

      
      Return all the Schemas Maps in the database.

      Returns:An interface into a list of EDMSchemaMapsThrows:EdmiException - If the method fails, or if the name are unset.

    • getQuerySchema

      EDMApplicationSchema getQuerySchema(java.lang.String name,
                                          EDMExpressSchema forSchema)
                                   throws EdmiException

      
      Get a query schema

      Parameters:name - name of the query schemaforSchema - Express schema for the query schema (query schema name is NOT unique)Returns:a query schema objectThrows:EdmiException - if the method fails

    • getRuleSchema

      EDMApplicationSchema getRuleSchema(java.lang.String name,
                                         EDMExpressSchema forSchema)
                                  throws EdmiException

      
      Get a query schema

      Parameters:name - name of the query schemaforSchema - Express schema for the query schema (query schema name is NOT unique)Returns:a query schema objectThrows:EdmiException - if the method fails

    • getAggregate

      EDMAggregate getAggregate(long id)
                         throws EdmiException

      
      Get an aggregate wrapper

      Parameters:id - aggregate idReturns:aggregate wrapperThrows:EdmiException - if the method fails

    • getInstance

      EDMInstance getInstance(long id)
                       throws EdmiException

      
      Get an instance wrapper

      Parameters:id - instance idReturns:instance wrapperThrows:EdmiException - if the method fails

    • getRow

      EDMRow getRow(long id)
             throws EdmiException

      
      Get an EDMRow wrapper

      Parameters:id - instance id, 0 if irrelevantReturns:instance wrapperThrows:EdmiException - if the method fails

    • getSelect

      EDMSelect getSelect()
                   throws EdmiException

      
      Get an empty SELECT wrapper

      Returns:a SELECT wrapperThrows:EdmiException - if the method fails

    • getQueryResult

      EDMQueryResult getQueryResult()
                             throws EdmiException

      
      Get an empty QueryResult wrapper

      Returns:a QueryResult wrapperThrows:EdmiException - if the method fails

    • getEDMGroup

      EDMGroup getEDMGroup(java.lang.String name)
                    throws EdmiException

      
      Get an EDMGroup wrapper

      Parameters:name - user nameReturns:EDMGroupt objectThrows:EdmiException - if the method fails

    • getEDMUser

      EDMUser getEDMUser(java.lang.String name)
                  throws EdmiException

      
      Get an EDMUser wrapper

      Parameters:name - user nameReturns:EDMUser objectThrows:EdmiException - if the method fails

    • getEDMUser

      EDMUser getEDMUser(long instanceId)
                  throws EdmiException

      
      Get an EDMUser wrapper

      Parameters:instanceId - instanceIdReturns:EDMUser objectThrows:EdmiException - if the method fails

    • getEDMGroup

      EDMGroup getEDMGroup(long instanceId)
                    throws EdmiException

      
      Get an EDMGroup wrapper

      Parameters:instanceId - instanceIdReturns:EDMGroupt objectThrows:EdmiException - if the method fails

    • getEDMUserOrGroup

      EDMUserOrGroup getEDMUserOrGroup(long id)
                                throws EdmiException

      
      Get an EDMUserOrGroup wrapper based on instance id

      Parameters:id - instanceIdReturns:EDMUserOrGroup objectThrows:EdmiException - if the method fails

    • listEDMGroups

      EDMGroup[] listEDMGroups()
                        throws EdmiException

      
      Get all EDM groups

      Returns:list of group objects, empty list if none foundThrows:EdmiException - if the method fails

    • listEDMUsers

      EDMUser[] listEDMUsers()
                      throws EdmiException

      
      Get all EDM groups

      Returns:list of group objects, empty list if none foundThrows:EdmiException - if the method fails

    • getSystemShadow

      EDMInstance getSystemShadow(EDMInstance ee)
                           throws EdmiException

      
      Get the shadow instance in system data model for a model,schema,...

      Parameters:ee - instanmce to get shadow forReturns:the system instanceThrows:EdmiException - if the method fails

    • getXmlConfiguration

      EDMRow getXmlConfiguration(EDMExpressSchema schema,
                                 java.lang.String name)
                          throws EdmiException

      
      Create a new XmlConfiguration in this database.

      Parameters:schema - Schema to assign the XML cofiguration to.name - name of the new configurationReturns:A array of EDMRuleSchema.Throws:EdmiException - If the method fails.

    • listXmlConfigurations

      EDMRow[] listXmlConfigurations(EDMExpressSchema schema,
                                     java.lang.String filter)
                              throws EdmiException

      
      Returns all or some XmlConfigurations in this EDM Database.

      Parameters:schema - Schema to search in, if null search in all schematafilter - optional name mask, wildcards = *?.Returns:A array of EDMRuleSchema.Throws:EdmiException - If the method fails.