Class MSAccessProjectLayout
The add-in exports an Access database (for example MyDb.accdb) into a
source folder, by default MyDb.accdb.src, which contains the
vcs-options.json configuration file. isAccessProject(File)
accepts a directory when vcs-options.json is found either directly in
it or in one of its immediate subdirectories.
Exported database objects (VBA modules, forms, reports, queries, macros, table definitions) are reported as source directories. The add-in does not define documentation or test directories, so those accessors return empty lists.
- Since:
- 1.4.3
- Author:
- Viktor Tovstyi
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final StringConfiguration file created by msaccess-vcs-addin in the export folder.Fields inherited from class ProjectLayout
NO_MODULES -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate static FilefindSourceDir(File projectDir) Locates the msaccess-vcs-addin export folder for a project directory.Returns documentation directories for the Access project.Returns source directories exported by msaccess-vcs-addin.getTests()Returns test source directories for the Access project.static booleanisAccessProject(File projectDir) Checks whether a directory contains an MS Access project exported by msaccess-vcs-addin.Methods inherited from class ProjectLayout
getExcludeDirs, getModules, getParentId, getProjectDir, getProjectId, getProjectLayoutType, getProjectName, getRelativePath, getRelativePath, getRelativePath, getTempDir, isExcludedPath, listDirectories, listFiles, projectDir, setExcludeDirs
-
Field Details
-
VCS_OPTIONS_FILE_NAME
Configuration file created by msaccess-vcs-addin in the export folder.- See Also:
-
-
Constructor Details
-
MSAccessProjectLayout
public MSAccessProjectLayout()Creates an MS Access project layout instance.
-
-
Method Details
-
isAccessProject
Checks whether a directory contains an MS Access project exported by msaccess-vcs-addin.The directory qualifies when it contains
vcs-options.jsonitself or when one of its immediate subdirectories (such asMyDb.accdb.srcorsource) does.- Parameters:
projectDir- directory to examine- Returns:
truewhen an msaccess-vcs-addin export folder is detected;falseotherwise
-
findSourceDir
-
getSources
Returns source directories exported by msaccess-vcs-addin.Paths are relative to the project directory and only existing folders (modules, forms, reports, queries, macros, tables, table definitions, relations) are included.
- Specified by:
getSourcesin classProjectLayout- Returns:
- list of existing export subdirectories; empty if none are found
-
getDocuments
Returns documentation directories for the Access project.- Specified by:
getDocumentsin classProjectLayout- Returns:
- empty list; msaccess-vcs-addin does not define a documentation folder
-
getTests
Returns test source directories for the Access project.- Specified by:
getTestsin classProjectLayout- Returns:
- empty list; msaccess-vcs-addin does not define a test folder
-