Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.1.0)

E17493-02

oracle.ide.index
Class IndexManager

java.lang.Object
  extended by oracle.ide.index.IndexManager

public abstract class IndexManager
extends java.lang.Object

Manages Index instances.


Constructor Summary
IndexManager()
           
 
Method Summary
abstract  void addIndexer(java.lang.Class<? extends Indexer> indexer)
          Deprecated. Indexer implementations must be registered through the extension manifest hook
abstract  void addIndexer(java.lang.Class<? extends Node> nodeClass, java.lang.Class<? extends Indexer> indexer)
          Deprecated. Indexer implementations must be registered through the extension manifest hook
abstract  Index getIndex(Project project)
          Deprecated. Use getIndex(Workspace,Project).
abstract  Index getIndex(Project project, ContentSet content)
          Deprecated. Use getIndex(Workspace,Project,ContentSet).
abstract  Index getIndex(Project project, java.net.URL url)
          Deprecated. Use getIndex(Workspace,Project,URL).
abstract  Index getIndex(Project project, URLPath path)
          Deprecated. Use getIndex(Workspace,Project,URLPath).
abstract  Index getIndex(Workspace workspace)
          Get the index for the application content.
abstract  Index getIndex(Workspace workspace, ContentSet content)
          Get the index for the given ContentSet in the application content.
abstract  Index getIndex(Workspace workspace, Project project)
          Get the index for the given project.
abstract  Index getIndex(Workspace workspace, Project project, ContentSet content)
          Get the index for the given ContentSet in the scope of the given project.
abstract  Index getIndex(Workspace workspace, Project project, FileSet fileSet)
          Get the index for the given FileSet in the scope of the given project.
abstract  Index getIndex(Workspace workspace, Project project, Path path)
          Get the index for the given Path in the scope of the given project.
abstract  Index getIndex(Workspace workspace, Project project, java.net.URL url)
          Get the index for the given URL in the scope of the given project.
abstract  Index getIndex(Workspace workspace, Project project, URLPath path)
          Get the index for the given URLPath in the scope of the given project.
static IndexManager getIndexManager()
          Get the IndexManager implementation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IndexManager

public IndexManager()
Method Detail

getIndexManager

public static IndexManager getIndexManager()
Get the IndexManager implementation.

Returns:
the IndexManager implementation

getIndex

public abstract Index getIndex(Workspace workspace)
Get the index for the application content. It is the caller's responsibility to call Index.release() when they are finished with this index.

Parameters:
workspace - the application workspace
Returns:
the index for the application content

getIndex

public abstract Index getIndex(Workspace workspace,
                               ContentSet content)
Get the index for the given ContentSet in the application content. It is the caller's responsibility to call Index.release() when they are finished with this index.

Parameters:
workspace - the application workspace
content - the content set
Returns:
the index

getIndex

public abstract Index getIndex(Workspace workspace,
                               Project project)
Get the index for the given project. The index will include all of the project content, but not its libraries, dependencies, JDK, etc. It is the caller's responsibility to call Index.release() when they are finished with this index.

Parameters:
workspace - the workspace
project - the project
Returns:
the index for the project

getIndex

public abstract Index getIndex(Workspace workspace,
                               Project project,
                               ContentSet content)
Get the index for the given ContentSet in the scope of the given project. This can be used, for example, to get an index for a subset of the project content. It is the caller's responsibility to call Index.release() when they are finished with this index.

Parameters:
workspace - the workspace
project - the project
content - the content set
Returns:
the index

getIndex

public abstract Index getIndex(Workspace workspace,
                               Project project,
                               URLPath path)
Get the index for the given URLPath in the scope of the given project. This can be used, for example, to index a library used by a project. Note that this method should not be used to index paths from a content set, as doing so would ignore the filters from the content set. This can result in far more files being indexed than is necessary. For content sets, use #getIndex(Project,ContentSet). It is the caller's responsibility to call Index.release() when they are finished with this index.

Parameters:
workspace - the workspace
project - the project
path - the URL path
Returns:
the index

getIndex

public abstract Index getIndex(Workspace workspace,
                               Project project,
                               Path path)
Get the index for the given Path in the scope of the given project. It is the caller's responsibility to call Index.release() when they are finished with this index.

Parameters:
workspace - the workspace
project - the project
path - the path
Returns:
the index

getIndex

public abstract Index getIndex(Workspace workspace,
                               Project project,
                               FileSet fileSet)
Get the index for the given FileSet in the scope of the given project. It is the caller's responsibility to call Index.release() when they are finished with this index.

Parameters:
workspace - the workspace
project - the project
fileSet - the file set
Returns:
the index

getIndex

public abstract Index getIndex(Workspace workspace,
                               Project project,
                               java.net.URL url)
Get the index for the given URL in the scope of the given project. Note that this method should not be used to index paths from a content set, as doing so would ignore the filters from the content set. This can result in far more files being indexed than is necessary. For content sets, use #getIndex(Project,ContentSet). It is the caller's responsibility to call Index.release() when they are finished with this index.

Parameters:
workspace - the workspace
project - the project
url - the URL
Returns:
the index

getIndex

@Deprecated
public abstract Index getIndex(Project project)
Deprecated. Use getIndex(Workspace,Project).

Get the index for the given project. The index will include all of the project content, but not its libraries, dependencies, JDK, etc. It is the caller's responsibility to call Index.release() when they are finished with this index.

Parameters:
project - the project
Returns:
the index for the project

getIndex

@Deprecated
public abstract Index getIndex(Project project,
                                          ContentSet content)
Deprecated. Use getIndex(Workspace,Project,ContentSet).

Get the index for the given ContentSet in the scope of the given project. This can be used, for example, to get an index for a subset of the project content. It is the caller's responsibility to call Index.release() when they are finished with this index.

Parameters:
project - the project
content - the content set
Returns:
the index

getIndex

@Deprecated
public abstract Index getIndex(Project project,
                                          URLPath path)
Deprecated. Use getIndex(Workspace,Project,URLPath).

Get the index for the given URLPath in the scope of the given project. This can be used, for example, to index a library used by a project. Note that this method should not be used to index paths from a content set, as doing so would ignore the filters from the content set. This can result in far more files being indexed than is necessary. For content sets, use #getIndex(Project,ContentSet). It is the caller's responsibility to call Index.release() when they are finished with this index.

Parameters:
project - the project
path - the URL path
Returns:
the index

getIndex

@Deprecated
public abstract Index getIndex(Project project,
                                          java.net.URL url)
Deprecated. Use getIndex(Workspace,Project,URL).

Get the index for the given URL in the scope of the given project. Note that this method should not be used to index paths from a content set, as doing so would ignore the filters from the content set. This can result in far more files being indexed than is necessary. For content sets, use #getIndex(Project,ContentSet). It is the caller's responsibility to call Index.release() when they are finished with this index.

Parameters:
project - the project
url - the URL
Returns:
the index

addIndexer

@Deprecated
public abstract void addIndexer(java.lang.Class<? extends Indexer> indexer)
Deprecated. Indexer implementations must be registered through the extension manifest hook

Add an Indexer class which will be called for all files being indexed.

Parameters:
indexer - the Indexer class to be added

addIndexer

@Deprecated
public abstract void addIndexer(java.lang.Class<? extends Node> nodeClass,
                                           java.lang.Class<? extends Indexer> indexer)
Deprecated. Indexer implementations must be registered through the extension manifest hook

Add an Indexer class for files with the given Node type. Note that multiple indexers can be added for a given file type. They will be called in the order they were added.

Parameters:
nodeClass - the Node subclass
indexer - the Indexer class to be added

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.1.0)

E17493-02

Copyright © 1997, 2011, Oracle. All rights reserved.