001: /*
002: * Copyright (c) 2004 JETA Software, Inc. All rights reserved.
003: *
004: * Redistribution and use in source and binary forms, with or without modification,
005: * are permitted provided that the following conditions are met:
006: *
007: * o Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: *
010: * o Redistributions in binary form must reproduce the above copyright notice,
011: * this list of conditions and the following disclaimer in the documentation
012: * and/or other materials provided with the distribution.
013: *
014: * o Neither the name of JETA Software nor the names of its contributors may
015: * be used to endorse or promote products derived from this software without
016: * specific prior written permission.
017: *
018: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
019: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
020: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
021: * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
022: * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
023: * INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
024: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
025: * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
026: * INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028: */
029:
030: package com.jeta.forms.project;
031:
032: import javax.swing.ImageIcon;
033:
034: /**
035: * This interface defines methods for project management. A project is composed
036: * of a set of 'source' directories. The application uses these diectories to
037: * form absolute/relative paths for forms and image resources when in design
038: * mode. When in run mode, the forms are loaded from the classpath. When in
039: * design mode, forms are loaded from the source paths. It is the responsibility
040: * of the ProjectManager to handle loading of form and image resources.
041: *
042: * @author Jeff Tassin
043: */
044: public interface ProjectManager {
045: /**
046: * component id for the JETARegistry
047: */
048: public static final String COMPONENT_ID = "jeta.forms.projectManager";
049:
050: /**
051: * Clears any cached resources such as images.
052: */
053: public void clearResourceCache();
054:
055: /**
056: * Returns a valid absolute path for a resource given only a relative path.
057: * The the registered source paths are searched to determine if the
058: * relativePath exists within one of the source paths. The source paths are
059: * set by the user for a given project.
060: *
061: * @return a valid absolute path given a relative path. Null is returned if
062: * no resource matches the given relative path.
063: */
064: public String getAbsolutePath(String relativePath);
065:
066: /**
067: * Returns the relative path given an absolute path to a resource. The
068: * relative path is determined using the source directories. If the path
069: * does not lie within a source directory, null is returned.
070: *
071: * @return a valid relative package/filename given an absolute path.
072: */
073: public String getRelativePath(String absPath);
074:
075: /**
076: * Determines if the given absolute path lies within one of the registered
077: * source directories.
078: *
079: * @return true if the given absolute path lies within one of the source
080: * directories.
081: */
082: public boolean isValidAbsolutePath(String path);
083:
084: /**
085: * Returns true if the given relative path exists and is a file.
086: *
087: * @return true if the given relative resource exists and is a file
088: */
089: public boolean isValidResource(String relpath);
090:
091: /**
092: * Utility method that loads an image from the CLASSPATH.
093: *
094: * @param imageName
095: * the subdirectory and name of image file (i.e.
096: * images/edit16.gif )
097: */
098: public ImageIcon loadImage(String imageName);
099:
100: }
|