org.eclipse.wst.common.componentcore.resources
Interface IVirtualComponent

All Superinterfaces:

IVirtualContainer, IVirtualResource

public interface IVirtualComponent

extends IVirtualContainer

Represents a component as defined by the .wtpmodules file.

A component is a container of virtual resources which has other features that describe the component including:

• getComponentTypeId()

  Since:

  1.0

  Field Summary

  Fields inherited from interface org.eclipse.wst.common.componentcore.resources.IVirtualResource

  COMPONENT, FILE, FOLDER, FORCE, IGNORE_EXCLUSIONS, IGNORE_UNDERLYING_RESOURCE, NONE

  Method Summary

  java.lang.String	getComponentTypeId() The componentTypeId is used to understand how this component should be edited and deployed.
  java.util.Properties	getMetaProperties() MetaProperties are String-based name-value pairs that include information about this component that may be relevant to clients or the way that clients edit or deploy components.
  IPath[]	getMetaResources() MetaResources provide a loose mechanism for components that would like to list off the metadata-resources available in the component which can aid or expedite searching for this resources.
  java.lang.String	getName() The name of the component must be unique within its enclosing project.
  IVirtualReference[]	getReferences() Virtual components may reference other virtual components to build logical dependency trees.
  IVirtualResource[]	getResources(java.lang.String aResourceType) Returns all virtual resources of a given type.
  void	setComponentTypeId(java.lang.String aComponentTypeId) The componentTypeId is used to understand how this component should be edited and deployed.
  void	setMetaResources(IPath[] theMetaResourcePaths) MetaResources provide a loose mechanism for components that would like to list off the metadata-resources available in the component which can aid or expedite searching for this resources.
  void	setReferences(IVirtualReference[] theReferences) Virtual components may reference other virtual components to build logical dependency trees.

  Methods inherited from interface org.eclipse.wst.common.componentcore.resources.IVirtualContainer

  create, exists, findMember, findMember, getFile, getFolder, members, members

  Methods inherited from interface org.eclipse.wst.common.componentcore.resources.IVirtualResource

  createLink, delete, equals, exists, getComponent, getFileExtension, getParent, getProject, getProjectRelativePath, getResourceType, getRuntimePath, getType, getUnderlyingResource, getUnderlyingResources, getWorkspaceRelativePath, isAccessible, setResourceType

  Method Detail

  getName

  public java.lang.String getName()

  The name of the component must be unique within its enclosing project.

  Specified by:

  getName in interface IVirtualResource

  Returns:

  The name of the component.

  See Also:

  IVirtualResource.getRuntimePath()

  getComponentTypeId

  public java.lang.String getComponentTypeId()

  The componentTypeId is used to understand how this component should be edited and deployed. Examples include "jst.web" or "jst.utility". The componentTypeId can be set to any value when created so long as that value makes sense to the clients. Standard componentTypeIds may be available for common component types.

  Returns:

  The componentTypeId, a string based identifier that indicates the component

  setComponentTypeId

  public void setComponentTypeId(java.lang.String aComponentTypeId)

  The componentTypeId is used to understand how this component should be edited and deployed. Examples include "jst.web" or "jst.utility". The componentTypeId can be set to any value when created so long as that value makes sense to the clients. Standard componentTypeIds may be available for common component types.

  Parameters:

  aComponentTypeId - A value which is either standard for a common component type or client-defined for a custom component type

  getMetaProperties

  public java.util.Properties getMetaProperties()

  MetaProperties are String-based name-value pairs that include information about this component that may be relevant to clients or the way that clients edit or deploy components.

  Returns:

  A by-reference instance of the properties for this component.

  getMetaResources

  public IPath[] getMetaResources()

  MetaResources provide a loose mechanism for components that would like to list off the metadata-resources available in the component which can aid or expedite searching for this resources.

  Clients are not required to get or set the MetaResources for a component.

  Returns:

  A by-value copy of the MetaResources array

  See Also:

  setMetaResources(IPath[])

  setMetaResources

  public void setMetaResources(IPath[] theMetaResourcePaths)

  MetaResources provide a loose mechanism for components that would like to list off the metadata-resources available in the component which can aid or expedite searching for this resources.

  Clients are not required to get or set the MetaResources for a component. The existing MetaResources will be overwritten after the call to this method.

  Parameters:

  theMetaResourcePaths - An array of paths that will become the new MetaResource array.

  getResources

  public IVirtualResource[] getResources(java.lang.String aResourceType)

  Returns all virtual resources of a given type.

  Virtual Resources can have a type associated with them. This method will find those resources which are tagged with a given resource type The returned array could be a mix of IVirtualFiles or IVirtualFolders

  null may be supplied to this method, which will return all resources without a resourceType.

  Parameters:

  aResourceType - A client-defined resource type that was used to create 0 or more resources within this component

  Returns:

  An array of those resources which matched the resourceType

  getReferences

  public IVirtualReference[] getReferences()

  Virtual components may reference other virtual components to build logical dependency trees.

  Each virtual reference will indicate how the content of the reference will be absorbed by this component. Each virtual reference will always specify an enclosing component that will be this component.

  Returns:

  A by-value copy of the virtual reference array

  setReferences

  public void setReferences(IVirtualReference[] theReferences)

  Virtual components may reference other virtual components to build logical dependency trees.

  Each virtual reference will indicate how the content of the reference will be absorbed by this component. Each virtual reference will always specify an enclosing component that will be this component. Any references specified in the array which do not specify an enclosing component that matches this component will be modified to specify this virtual component.

  Existing virtual references will be overwritten when this method is called.

  Parameters:

  theReferences - A by-value copy of the virtual reference array