KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pentaho > core > solution > ISolutionFile


1 /*
2  * Copyright 2006 Pentaho Corporation. All rights reserved.
3  * This software was developed by Pentaho Corporation and is provided under the terms
4  * of the Mozilla Public License, Version 1.1, or any later version. You may not use
5  * this file except in compliance with the license. If you need a copy of the license,
6  * please go to http://www.mozilla.org/MPL/MPL-1.1.txt. The Original Code is the Pentaho
7  * BI Platform. The Initial Developer is Pentaho Corporation.
8  *
9  * Software distributed under the Mozilla Public License is distributed on an "AS IS"
10  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. Please refer to
11  * the license for the specific language governing your rights and limitations.
12 */
13 package org.pentaho.core.solution;
14
15 /**
16  * A solution file is an abstract represention of either a file
17  * or a directory. This allows us to treat files and directories
18  * as the same thing for the purposes of hierarchical navigation
19  *
20  * @author jdixon
21  *
22  */
23 public interface ISolutionFile {
24
25     /**
26      * @return true if the ISolutionFile points to a directory.
27      */
28     public boolean isDirectory();
29
30     /**
31      * @return The name of the file/directory
32      */
33     public String JavaDoc getFileName();
34
35     /**
36      * @return path within the solution to the file/directory.
37      */
38     public String JavaDoc getSolutionPath();
39
40     /**
41      * @return Name of the solution this file/directory is contained within
42      */
43     public String JavaDoc getSolution();
44
45     /**
46      * @return fully qualified path to this file/directory
47      */
48     public String JavaDoc getFullPath();
49
50     // public String getFileType();
51
52     /**
53      * If this is a directory, will list all children files/directories for hierarchical
54      * navigation.
55      */
56     public ISolutionFile[] listFiles();
57     
58     /**
59      *
60      * @return true if this is the root solution folder
61      * NOTE: This will always return false for a filebased solution
62      */
63     public boolean isRoot();
64 }
65
Popular Tags