|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InternalKernelServices | Line # 33 | 0 | 0 | - |
-1.0
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
No Tests | |||
1 | /* $Id: InternalKernelServices.java,v 1.1 2008/07/26 07:58:30 m31 Exp $ | |
2 | * | |
3 | * This file is part of the project "Hilbert II" - http://www.qedeq.org | |
4 | * | |
5 | * Copyright 2000-2008, Michael Meyling <mime@qedeq.org>. | |
6 | * | |
7 | * "Hilbert II" is free software; you can redistribute | |
8 | * it and/or modify it under the terms of the GNU General Public | |
9 | * License as published by the Free Software Foundation; either | |
10 | * version 2 of the License, or (at your option) any later version. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | * GNU General Public License for more details. | |
16 | */ | |
17 | ||
18 | package org.qedeq.kernel.bo.module; | |
19 | ||
20 | import java.io.File; | |
21 | ||
22 | import org.qedeq.kernel.base.module.Specification; | |
23 | import org.qedeq.kernel.bo.context.KernelServices; | |
24 | import org.qedeq.kernel.common.ModuleAddress; | |
25 | import org.qedeq.kernel.common.SourceFileExceptionList; | |
26 | ||
27 | /** | |
28 | * The kernel internal service methods are assembled here. Needed by the kernel and its helpers. | |
29 | * | |
30 | * @version $Revision: 1.1 $ | |
31 | * @author Michael Meyling | |
32 | */ | |
33 | public interface InternalKernelServices extends KernelServices { | |
34 | ||
35 | /** | |
36 | * Get buffer directory for QEDEQ module files. | |
37 | * | |
38 | * @return buffer directory. | |
39 | */ | |
40 | public File getBufferDirectory(); | |
41 | ||
42 | /** | |
43 | * Get directory for generated files. | |
44 | * | |
45 | * @return Generation directory. | |
46 | */ | |
47 | public File getGenerationDirectory(); | |
48 | ||
49 | /** | |
50 | * Get {@link KernelQedeqBo} for an address. | |
51 | * | |
52 | * @param address Look for this address. | |
53 | * @return Existing or new {@link KernelQedeqBo}, if address is malformed | |
54 | * <code>null</code> is returned. | |
55 | */ | |
56 | public KernelQedeqBo getKernelQedeqBo(ModuleAddress address); | |
57 | ||
58 | /** | |
59 | * Transform an URL address into a local file path where the QEDEQ module is buffered. | |
60 | * If the module is not buffered <code>null</code> is returned. | |
61 | * | |
62 | * @param address Get local address for this QEDEQ module address. | |
63 | * @return Local file path for that <code>address</code>. | |
64 | */ | |
65 | public File getLocalFilePath(ModuleAddress address); | |
66 | ||
67 | /** | |
68 | * Load specified QEDEQ module from QEDEQ parent module. | |
69 | * | |
70 | * @param parent Parent module address. | |
71 | * @param spec Specification for another QEDEQ module. | |
72 | * @return Loaded module. | |
73 | * @throws SourceFileExceptionList Loading failed. | |
74 | */ | |
75 | public KernelQedeqBo loadModule(ModuleAddress parent, Specification spec) | |
76 | throws SourceFileExceptionList; | |
77 | ||
78 | /** | |
79 | * Get DAO for reading and writing QEDEQ modules from or to a file. | |
80 | * | |
81 | * @return DAO. | |
82 | */ | |
83 | public QedeqFileDao getQedeqFileDao(); | |
84 | ||
85 | } |
|