MapForceServer Class

www.altova.com Imprimer cette rubrique Un niveau supérieur

Accueil > 

MapForceServer Class

La classe MapForceServer crée une nouvelle instance d'objet MapForce Server, et fournit un accès au moteur MapForce Server.

 

 

Méthodes

 

Méthode addParameter

Assigne une valeur à un paramètre définit dans le mappage.

 

public void addParameter(java.lang.String name,
                        java.lang.String value)

 

 

Méthode clearOptions

Supprime la liste des options précédemment définies par la méthode SetOption. Toutes les options définies par le biais de la méthode SetOption sont valides pour la durée de vie de l'objet. Appeler cette méthode si vous souhaitez explicitement effacer toutes les options définies précédemment.

 

public void clearOptions()

 

 

Méthode clearParameterList

Supprime la liste des paramètres.

 

public void clearParameterList()

 

 

Méthode getAPIMajorVersion

Obtient la version majeure de l'API MapForce Server. Elle peut être différente de la version de produit si l'API est connectée à un autre serveur.

 

public int getAPIMajorVersion()

 

 

Méthode getAPIMinorVersion

Obtient la version mineure de l'API MapForce Server. Elle peut être différente de la version de produit si l'API est connectée à un autre serveur.

 

public int getAPIMinorVersion()

 

 

Méthode getAPIServicePackVersion

Obtient la version du service pack de l'API MapForce Server. Elle peut être différente de la version de produit si l'API est connectée à un autre serveur.

 

public int getAPIServicePackVersion()

 

 

Méthode getLastExecutionMessage

Obtient le message reçu pendant la dernière commande Run.

 

public java.lang.String getLastExecutionMessage()

 

 

Méthode getMajorVersion

Obtient la version majeure du produit, en tant que nombre des années débutant avec 1998 (par exemple, "16" pour Altova MapForce Server 2014 r2 sp1 (x64)).

 

public int getMajorVersion()
                  throws MapForceServerException

 

 

Méthode getMinorVersion

Obtient la version mineure du produit (par exemple, "2" pour Altova MapForce Server 2014 r2 sp1 (x64)).

 

public int getMinorVersion()
                  throws MapForceServerException

 

 

Méthode getOutputParameter

Obtient la sortie de string générée par la dernière commande run. Retourne null si aucune sortie n'est générée. Cette fonction requiert un paramètre de string qui identifie le nom du composant de sortie dans MapForce.

 

public String getOutputParameter( String name )

 

 

Méthode getProductName

Obtient le nom du produit (par exemple, "Altova MapForce Server" pour Altova MapForce Server 2014 r2 sp1 (x64)).

 

public java.lang.String getProductName()
                              throws MapForceServerException

 

 

Méthode getProductNameAndVersion

Obtient le nom et complet du produit et la version du produit (par exemple, "Altova MapForce Server 2014 r2 sp1 (x64)").

 

public java.lang.String getProductNameAndVersion()
                                        throws MapForceServerException

 

 

Méthode getServicePackVersion

Obtient la version du pack de service du produit (par exemple, "1" pour Altova MapForce Server 2014 r2 sp1 (x64)).

 

public int getServicePackVersion()
                        throws MapForceServerException

 

 

Méthode is64Bit

Retourne true si le moteur MapForce Server est un exécutable 64-bit.

 

public boolean is64bit()
              throws MapForceServerException

 

 

Méthode run

Exécute un fichier MapForce Server Execution (fichier .mfx). Retourne true en cas de succès ; sinon, false.

 

public boolean run(java.lang.String mappingPath)
          throws MapForceServerException

 

 

Méthode setOption

Définit une option avant d'exécuter le mappage. Le premier argument spécifie le nom de l'option, alors que le second argument spécifie la valeur d'option. Cette méthode est particulièrement utile lorsqu'un mappage a été conçu pour consommer des Ressources globales (voir Ressources globales Altova). Les options prises en charge actuellement sont les suivantes :

 

Nom de l'option

Description

globalresourcefile (or gr)

Un chemin de fichier de Ressources globales. (Lorsque cette option est spécifiée, un nom de configuration de Ressources globales doit aussi être spécifié, voir item suivant).

globalresourceconfig (or gc)

Un nom de configuration de Ressources globales. (Lorsque cette option est spécifiée, un chemin de fichier de Ressources globales doit aussi être spécifié, voir item suivant).

catalog

Le chemin vers un fichier personnalisé RootCatalog.xml. Cette option vous permet de spécifier un fichier de catalogue personnalisé utilisé pour résoudre des URL utilisées par le mappage. Le catalogue par défaut se trouve dans le sous-répertoire etc du répertoire d'installation du programme.

taxonomy-package

Le chemin vers un pack de taxonomie XBRL personnalisé, si un chemin est requis par le mappage.

taxonomy-packages-config-file

Le chemin vers une configuration de pack de taxonomie XBRL personnalisé, si une configuration est requise par le mappage.

 

Toutes les options de définies sont valides pour la durée de vie de l'objet. Si vous définissez deux fois une option avec le même nom, l'option précédente sera écrasée. Pour effacer explicitement toutes les options, appeler la méthode ClearOptions().

 

public void setOption(java.lang.String option_name,
            java.lang.String value)

 

 

Méthode setServerPath

Définit le chemin de l'exécutable MapForce Server.

 

public void setServerPath(java.lang.String serverFile)

 

 

Méthode setWorkingDirectory

Définit le répertoire actuel pour exécuter des tâches (les chemins relatifs seront évalués par rapport au répertoire de travail).

 

public void setWorkingDirectory(java.lang.String workingDirectory)


© 2019 Altova GmbH