cim1

Class CIMModelFactory

java.lang.Object

cim1.CIMModelFactory

public class CIMModelFactory
extends java.lang.Object

This file has been automatically generated by CIMGateway

Constructor Summary

Constructors

Constructor and Description
CIMModelFactory(CIMModel model, CIMModel boundaryModel)

Method Summary

Modifier and Type	Method and Description
java.lang.String	checkProfile(java.io.Reader reader, java.lang.String filename)
java.lang.String	checkProfile(java.lang.String filename)
static boolean	checkVersion(java.io.Reader reader, java.lang.String name) Utility which checks the version of the CIMFile using its cimuri
static boolean	checkVersion(java.lang.String filename) Utility which checks the version of the CIMFile using its cimuri
static void	read(java.util.List<java.io.Reader> sourcesEQ, java.util.List<java.lang.String> sourcesEQNames, java.util.List<java.io.Reader> sourcesSSH, java.util.List<java.lang.String> sourcesSSHNames, java.util.List<java.io.Reader> sourcesTP, java.util.List<java.lang.String> sourcesTPNames, java.util.List<java.io.Reader> sourcesSV, java.util.List<java.lang.String> sourcesSVNames, java.util.List<java.io.Reader> sourcesME, java.util.List<java.lang.String> sourcesMENames, java.util.List<java.io.Reader> boundariesEQ, java.util.List<java.lang.String> boundariesEQNames, java.util.List<java.io.Reader> boundariesTP, java.util.List<java.lang.String> boundariesTPNames, CIMModel model, CIMModel boundaryModel, boolean complete) Utility meant to be called by the user of the lib if he manipulates some list of readers
static void	read(java.util.List<java.lang.String> sourcesEQNames, java.util.List<java.lang.String> sourcesSSHNames, java.util.List<java.lang.String> sourcesTPNames, java.util.List<java.lang.String> sourcesSVNames, java.util.List<java.lang.String> sourcesMENames, java.util.List<java.lang.String> boundariesEQNames, java.util.List<java.lang.String> boundariesTPNames, CIMModel model, CIMModel boundaryModel, boolean complete) Utility meant to be called by the user of the lib if he manipulates some list of files
static void	read(java.io.Reader reader, java.lang.String name, CIMModel model, CIMModel boundaryModel, boolean complete) Utility which allows to read a CIM File Using a reader.
static void	read(java.io.Reader sourceEQ, java.lang.String sourceEQName, java.io.Reader sourceSSH, java.lang.String sourceSSHName, java.io.Reader sourceTP, java.lang.String sourceTPName, java.io.Reader sourceSV, java.lang.String sourceSVName, java.io.Reader sourceME, java.lang.String sourceMEName, java.io.Reader boundaryEQ, java.lang.String boundaryEQName, java.io.Reader boundaryTP, java.lang.String boundaryTPName, CIMModel model, CIMModel boundaryModel, boolean complete) Utility meant to be called by the user of the lib if he manipulates readers
static void	read(java.lang.String filename, CIMModel model, CIMModel boundaryModel, boolean complete) Utility to read the CIM Files
static void	read(java.lang.String sourceEQName, java.lang.String sourceSSHName, java.lang.String sourceTPName, java.lang.String sourceSVName, java.lang.String sourceMEName, java.lang.String boundaryEQName, java.lang.String boundaryTPName, CIMModel model, CIMModel boundaryModel, boolean complete) Utility meant to be called by the user of the lib if he manipulates some list of files
static void	resolveLinks(CIMModel model, CIMModel boundaryModel) Utility to resolve the links after having parsed an XML instance During the parsing, the references to other classes in rdf:resource and rdf:about are stored (with the id) waiting for the resolveLinks Method.
static void	write(CIMModel model, java.io.FileWriter file) Utility called to write a merged CIM File
static void	write(CIMModel model, java.lang.String filename) Utility called to write a merged CIM File
static void	write(CIMModel model, Subset subset, java.io.FileWriter file) Utility called to write a CIM File associated to one subset
static void	write(CIMModel model, Subset subset, java.lang.String filename) Utility called to write a CIM File associated to one subset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CIMModelFactory

public CIMModelFactory(CIMModel model,
                       CIMModel boundaryModel)

Method Detail

read

public static void read(java.util.List<java.io.Reader> sourcesEQ,
                        java.util.List<java.lang.String> sourcesEQNames,
                        java.util.List<java.io.Reader> sourcesSSH,
                        java.util.List<java.lang.String> sourcesSSHNames,
                        java.util.List<java.io.Reader> sourcesTP,
                        java.util.List<java.lang.String> sourcesTPNames,
                        java.util.List<java.io.Reader> sourcesSV,
                        java.util.List<java.lang.String> sourcesSVNames,
                        java.util.List<java.io.Reader> sourcesME,
                        java.util.List<java.lang.String> sourcesMENames,
                        java.util.List<java.io.Reader> boundariesEQ,
                        java.util.List<java.lang.String> boundariesEQNames,
                        java.util.List<java.io.Reader> boundariesTP,
                        java.util.List<java.lang.String> boundariesTPNames,
                        CIMModel model,
                        CIMModel boundaryModel,
                        boolean complete)
                 throws InterpretationException,
                        java.lang.Exception,
                        BadSubsetException

Utility meant to be called by the user of the lib if he manipulates some list of readers

Parameters:

sourcesEQ - a list of Reader associated to EQ Files Those Readers are never closed in this function This is up to the user

sourcesEQNames - a list of name for each sourcesEQ Reader. Every Reader must have an associated name

sourcesSSH - a list of Reader associated to SSH Files Those Readers are never closed in this function This is up to the user

sourcesSSHNames - a list of name for each sourcesSSH Reader. Every Reader must have an associated name

sourcesTP - a list of Reader associated to TP Files Those Readers are never closed in this function This is up to the user

sourcesTPNames - a list of name for each sourcesTP Reader. Every Reader must have an associated name

sourcesSV - a list of Reader associated to SV File. Those Readers are never closed in this function This is up to the user

sourcesSVNames - a list of name for each sourcesSV Reader. Every Reader must have an associated name

sourcesME - a list of Reader associated to ME Files Those Readers are never closed in this function This is up to the user

sourcesMENames - a list of name for each sourcesME Reader. Every Reader must have an associated name

boundariesEQ - a list of Reader associated to boundariesEQ Files Those Readers are never closed in this function This is up to the user

boundariesEQNames - a list of name for each boundariesEQ Reader. Every Reader must have an associated name

boundariesTP - a list of Reader associated to boundariesTP Files Those Readers are never closed in this function This is up to the user

boundariesTPNames - a list of name for each boundariesTP Reader. Every Reader must have an associated name

model - the model which will be filled with model instances

boundaryModel - the boundary model which will be filled with boundaryModel instances

complete - a boolean which indicates what to do after the parsing. if true : we resolveLinks and checkConsistency if false : we stop there

Throws:

InterpretationException

java.lang.Exception

BadSubsetException

read

public static void read(java.util.List<java.lang.String> sourcesEQNames,
                        java.util.List<java.lang.String> sourcesSSHNames,
                        java.util.List<java.lang.String> sourcesTPNames,
                        java.util.List<java.lang.String> sourcesSVNames,
                        java.util.List<java.lang.String> sourcesMENames,
                        java.util.List<java.lang.String> boundariesEQNames,
                        java.util.List<java.lang.String> boundariesTPNames,
                        CIMModel model,
                        CIMModel boundaryModel,
                        boolean complete)
                 throws InterpretationException,
                        java.lang.Exception,
                        BadSubsetException

Utility meant to be called by the user of the lib if he manipulates some list of files

Parameters:

sourcesEQNames - a list of Files' path used to create sourcesEQ Reader

sourcesSSHNames - a list of Files' path used to create sourcesSSH Reader

sourcesTPNames - a list of Files' path used to create sourcesTP Reader

sourcesSVNames - a list of Files' path used to create sourcesSV Reader

sourcesMENames - a list of Files' path used to create sourcesME Reader

boundariesEQNames - a list of Files' path used to create boundariesEQ Reader

boundariesTPNames - a list of Files' path used to create boundariesTP Reader

model - the model which will be filled with model instances

boundaryModel - the boundary model which will be filled with boundaryModel instances

complete - a boolean which indicates what to do after the parsing. if true : we resolveLinks and check consistency if false : we stop there

Throws:

InterpretationException

java.lang.Exception

BadSubsetException

read

public static void read(java.io.Reader sourceEQ,
                        java.lang.String sourceEQName,
                        java.io.Reader sourceSSH,
                        java.lang.String sourceSSHName,
                        java.io.Reader sourceTP,
                        java.lang.String sourceTPName,
                        java.io.Reader sourceSV,
                        java.lang.String sourceSVName,
                        java.io.Reader sourceME,
                        java.lang.String sourceMEName,
                        java.io.Reader boundaryEQ,
                        java.lang.String boundaryEQName,
                        java.io.Reader boundaryTP,
                        java.lang.String boundaryTPName,
                        CIMModel model,
                        CIMModel boundaryModel,
                        boolean complete)
                 throws InterpretationException,
                        java.lang.Exception,
                        BadSubsetException

Utility meant to be called by the user of the lib if he manipulates readers

Parameters:

sourceEQ - an Reader associated to EQ Files This Reader is never closed in this function This is up to the user

sourceEQName - a name for the sourceEQ Reader. Every Reader must have an associated name

sourceSSH - an Reader associated to SSH Files This Reader is never closed in this function This is up to the user

sourceSSHName - a name for the sourceSSH Reader. Every Reader must have an associated name

sourceTP - an Reader associated to TP Files This Reader is never closed in this function This is up to the user

sourceTPName - a name for the sourceTP Reader. Every Reader must have an associated name

sourceSV - an Reader associated to SV Files This Reader is never closed in this function This is up to the user

sourceSVName - a name for the sourceSV Reader. Every Reader must have an associated name

sourceME - an Reader associated to ME Files This Reader is never closed in this function This is up to the user

sourceMEName - a name for the sourceME Reader. Every Reader must have an associated name

boundaryEQ - an Reader associated to boundaryEQ Files This Reader is never closed in this function This is up to the user

boundaryEQName - a name for the boundaryEQ Reader. Every Reader must have an associated name

boundaryTP - an Reader associated to boundaryTP Files This Reader is never closed in this function This is up to the user

boundaryTPName - a name for the boundaryTP Reader. Every Reader must have an associated name

model - the model which will be filled with model instances

boundaryModel - the boundary model which will be filled with boundaryModel instances

complete - a boolean which indicates what to do after the parsing. if true : we resolveLinks and checkConsistency if false : we stop there

Throws:

InterpretationException

java.lang.Exception

BadSubsetException

read

public static void read(java.lang.String sourceEQName,
                        java.lang.String sourceSSHName,
                        java.lang.String sourceTPName,
                        java.lang.String sourceSVName,
                        java.lang.String sourceMEName,
                        java.lang.String boundaryEQName,
                        java.lang.String boundaryTPName,
                        CIMModel model,
                        CIMModel boundaryModel,
                        boolean complete)
                 throws InterpretationException,
                        java.lang.Exception,
                        BadSubsetException

Utility meant to be called by the user of the lib if he manipulates some list of files

Parameters:

sourceEQName - a File path used to create sourcesEQ Reader

sourceSSHName - a File path used to create sourcesSSH Reader

sourceTPName - a File path used to create sourcesTP Reader

sourceSVName - a File path used to create sourcesSV Reader

sourceMENames - a File path used to create sourcesME Reader

boundaryEQName - a File path used to create boundaryEQ Reader

boundaryTPName - a File path used to create boundaryTP Reader

model - the model which will be filled with model instances

boundaryModel - the boundary model which will be filled with boundaryModel instances

complete - a boolean which indicates what to do after the parsing. if true : we resolveLinks and check consistency if false : we stop there

Throws:

InterpretationException

java.lang.Exception

BadSubsetException

read

public static void read(java.lang.String filename,
                        CIMModel model,
                        CIMModel boundaryModel,
                        boolean complete)
                 throws InterpretationException,
                        java.lang.Exception

Utility to read the CIM Files

Parameters:

filename - the filePath

model - the CIMModel were data will be stored

complete - if true, the Model will resolve Links after having parsed this file. if false, you will have to do it later.

Throws:

InterpretationException

java.lang.Exception

read

public static void read(java.io.Reader reader,
                        java.lang.String name,
                        CIMModel model,
                        CIMModel boundaryModel,
                        boolean complete)
                 throws java.lang.Exception,
                        InterpretationException

Utility which allows to read a CIM File Using a reader. We do not need the boundaryModel if we decide to not complete the model.

Parameters:

reader - The reader associated to the CIM File

name - The name associated to the reader, used in loggers

model - The CIM model where we store the data of the CIM File

boundaryModel - The CIM model where we store the data of the boundary CIM Files

complete - a boolean which indicates what to do after the parsing. if true : we resolveLinks and check consistency if false : we stop there

Throws:

InterpretationException

java.lang.Exception

checkVersion

public static boolean checkVersion(java.lang.String filename)
                            throws InterpretationException

Utility which checks the version of the CIMFile using its cimuri

Parameters:

filename - The path to the file to parse

Throws:

InterpretationException

checkVersion

public static boolean checkVersion(java.io.Reader reader,
                                   java.lang.String name)
                            throws InterpretationException,
                                   java.lang.Exception

Utility which checks the version of the CIMFile using its cimuri

Parameters:

reader - The reader associated to the file to parse

name - The name associated to the reader, used for loggers

Throws:

InterpretationException

java.lang.Exception

checkProfile

public java.lang.String checkProfile(java.lang.String filename)
                              throws InterpretationException,
                                     java.lang.Exception

Throws:

InterpretationException

java.lang.Exception

checkProfile

public java.lang.String checkProfile(java.io.Reader reader,
                                     java.lang.String filename)
                              throws InterpretationException,
                                     java.lang.Exception

Throws:

InterpretationException

java.lang.Exception

resolveLinks

public static void resolveLinks(CIMModel model,
                                CIMModel boundaryModel)
                         throws LinkageException

Utility to resolve the links after having parsed an XML instance During the parsing, the references to other classes in rdf:resource and rdf:about are stored (with the id) waiting for the resolveLinks Method. We optimize the way we create and search instances.

Parameters:

model - the CIM model where links will be resolved

boundaryModel - the CIM model used as a resource for the instances to links

Throws:

Linkage - Exception

LinkageException

write

public static void write(CIMModel model,
                         java.lang.String filename)
                  throws InterpretationException

Utility called to write a merged CIM File

Parameters:

model - the CIM model where data are stored

filename - the path to the file to be created

Throws:

InterpretationException

write

public static void write(CIMModel model,
                         java.io.FileWriter file)
                  throws InterpretationException

Utility called to write a merged CIM File

Parameters:

model - the CIM model where data are stored

file - the FileWriter where data will be written

Throws:

InterpretationException

write

public static void write(CIMModel model,
                         Subset subset,
                         java.lang.String filename)
                  throws InterpretationException

Utility called to write a CIM File associated to one subset

Parameters:

model - the CIM model where data are stored

subset - the subset associated to the data to write, and to the file to create

filename - the path of the file to write

Throws:

InterpretationException

write

public static void write(CIMModel model,
                         Subset subset,
                         java.io.FileWriter file)
                  throws InterpretationException

Utility called to write a CIM File associated to one subset

Parameters:

model - the CIM model where data are stored

subset - the subset associated to the data to write, and to the file to create

file - the FileWriter where data will be written

Throws:

InterpretationException