Java Doc for SourceFileMap.java in  » 6.0-JDK-Core » j2eeserver » org » netbeans » modules » j2ee » deployment » common » api » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » j2eeserver » org.netbeans.modules.j2ee.deployment.common.api 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.netbeans.modules.j2ee.deployment.common.api.SourceFileMap

All known Subclasses:   org.netbeans.modules.j2ee.deployment.impl.DefaultSourceMap,
SourceFileMap
abstract public class SourceFileMap (Code)
Extra file mapping service for each j2ee module. This service cover irregular source to distribution file mapping. Users of the mapping could update the mapping. Provider of the mapping has to ensure the mapping persistence. Note: the initial design is for non-static configuration file such as schema file used in CMP mapping, but it could be used to expose any kind of source-to-distribution mapping.
author:
   nn136682




Method Summary
abstract public  booleanadd(String distributionPath, FileObject sourceFile)
     Add new mapping or update existing mapping of the given distribution path. Provider of the mapping needs to extract and persist the relative path to ensure the mapping is in project sharable data.
abstract public  FileObject[]findSourceFile(String distributionPath)
     Returns the concrete file for the given distribution path.
final public static  SourceFileMapfindSourceMap(FileObject source)
     Returns a source file map for the module, or null if none can be identified.
final public static  SourceFileMapfindSourceMap(J2eeModule j2eeModule)
     Returns a source file map for the module, or null if none can be identified.
abstract public  StringgetContextName()
     Return context name, typically the J2EE module project name.
abstract public  FilegetDistributionPath(FileObject sourceFile)
     Returns the relative path in distribution of the given concrete source file.
abstract public  FilegetEnterpriseResourceDir()
     Returns directory paths to repository of enterprise resource definition files.
abstract public  File[]getEnterpriseResourceDirs()
     Returns directory paths to repository of enterprise resource definition files.
abstract public  FileObject[]getSourceRoots()
     Return source roots this file mapping is operate on.
abstract public  FileObjectremove(String distributionPath)
     Remove mapping for the given distribution path.



Method Detail
add
abstract public boolean add(String distributionPath, FileObject sourceFile)(Code)
Add new mapping or update existing mapping of the given distribution path. Provider of the mapping needs to extract and persist the relative path to ensure the mapping is in project sharable data. The mapping would be used in ensuring that during build time the source file is put at the right relative path in the distribution content.
Parameters:
  distributionPath - file path in the distribution content
Parameters:
  sourceFile - souce concrete file object. true if added successfully; false if source file is out of this mapping scope.



findSourceFile
abstract public FileObject[] findSourceFile(String distributionPath)(Code)
Returns the concrete file for the given distribution path.
Parameters:
  distributionPath - distribution path for to find source file for.



findSourceMap
final public static SourceFileMap findSourceMap(FileObject source)(Code)
Returns a source file map for the module, or null if none can be identified.
Parameters:
  source - A non-null source file (java, descriptor or dbschema) to establish mapping context.



findSourceMap
final public static SourceFileMap findSourceMap(J2eeModule j2eeModule)(Code)
Returns a source file map for the module, or null if none can be identified.
Parameters:
  ddbean - An instance of ddbean to establish mapping context.



getContextName
abstract public String getContextName()(Code)
Return context name, typically the J2EE module project name.



getDistributionPath
abstract public File getDistributionPath(FileObject sourceFile)(Code)
Returns the relative path in distribution of the given concrete source file.
Parameters:
  distributionPath - distribution path for to find source file for.



getEnterpriseResourceDir
abstract public File getEnterpriseResourceDir()(Code)
Returns directory paths to repository of enterprise resource definition files. If the directories pointed to by the returned path does not exists writing user of the method call could attempt to create it.



getEnterpriseResourceDirs
abstract public File[] getEnterpriseResourceDirs()(Code)
Returns directory paths to repository of enterprise resource definition files. If the directories pointed to by the returned path does not exists writing user of the method call could attempt to create it. For a stand-alone J2EE module, the returned list should contain only one path as returned by getEnterpriseResourceDir. For J2EE application module, the list contains resource directory paths of all child modules.



getSourceRoots
abstract public FileObject[] getSourceRoots()(Code)
Return source roots this file mapping is operate on.



remove
abstract public FileObject remove(String distributionPath)(Code)
Remove mapping for the given distribution path.
Parameters:
  distributionPath - file path in the distribution content



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

ww___w_._j___a___v_a___2__s_.___c_o__m__ | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.