Interface SourceInformation
-
- All Known Implementing Classes:
SourceInformationImpl
public interface SourceInformation
This interface describes the source of a model definition. This can be e.g. JAR, ZIP or LOCAL
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
SourceInformation.SourceType
this enum describes the type of the source of the model definition.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getFileName()
if the model definition was loaded from an xml/json file (or a zip archive) then this returns the name of the xml/json file (or the name of the zip entry)java.lang.String
getPathOffsetWithinArchive()
java.io.File
getRootPath()
depending ongetSourceType()
this either represents the name of zip archive or the base directory if local (i.e.SourceInformation.SourceType
getSourceType()
-
-
-
Method Detail
-
getRootPath
java.io.File getRootPath()
depending ongetSourceType()
this either represents the name of zip archive or the base directory if local (i.e. the path where the .jmd.xml file resides.)- Returns:
- the path
-
getFileName
java.lang.String getFileName()
if the model definition was loaded from an xml/json file (or a zip archive) then this returns the name of the xml/json file (or the name of the zip entry)- Returns:
- the name of the xml/json file from which the model definition was loaded.
-
getSourceType
SourceInformation.SourceType getSourceType()
- Returns:
- The
SourceInformation.SourceType
which indicates from where the model definition was loaded.
-
getPathOffsetWithinArchive
java.lang.String getPathOffsetWithinArchive()
- Returns:
- the path offset within the archive (if the model definition was loaded from an archive). Usually, this is
the parent path entry of
getFileName()
-
-