ISchema

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> eclipse >> pde >> internal >> core >> [ ischema overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.eclipse.pde.internal.core.ischema.ISchema

SOURCE |

Download org.eclipse.pde.internal.core.ischema.ISchema

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.pde.internal.core.ischema
Interface ISchema

All Superinterfaces:: org.eclipse.core.runtime.IAdaptable, org.eclipse.pde.core.IBaseModel, org.eclipse.pde.core.IModelChangeProvider, ISchemaObject, org.eclipse.pde.core.IWritable

public interface ISchema
extends ISchemaObject, org.eclipse.pde.core.IBaseModel, org.eclipse.pde.core.IModelChangeProvider

Objects of this class encapsulate data loaded from the XML Schema file that defines an Eclipse extension point. These files are used for three reasons:

To provide grammar that can be used by validation parsers to validate extensions that plug into this extension point
To provide additional metadata about this extension point that can be used by PDE to provide user assistence in plug-in development
To provide enough material that can be used by tools to compose a reference HTML documentation about this extension point.

Objects of this class can be changed if editable. Other classes can register as change listener in order to receive notification about these changes.

Field Summary

static java.lang.String P_PLUGIN


static java.lang.String P_POINT


static int REFRESH_ADD


static int REFRESH_DELETE


static int REFRESH_RENAME


Fields inherited from interface org.eclipse.pde.internal.core.ischema.ISchemaObject

P_DESCRIPTION, P_NAME

Method Summary

ISchemaElement findElement(java.lang.String name)
          Returns a reference to a schema element defined in this schema or null if not found.

ISchemaElement[] getCandidateChildren(ISchemaElement element)
          Returns an array of schema elements that can be children of the provided schema element.

IDocumentSection[] getDocumentSections()
          Returns an array of document sections that are defined in this schema.

int getElementCount()
          Returns a number of elements with global scope defined in this schema.

ISchemaElement[] getElements()
          Returns an array of elements with the global scope defined in this schema.

ISchemaInclude[] getIncludes()
          Returns a list of elements that correspond to the include statements in the schema file.

java.lang.String getPluginId()


java.lang.String getPointId()


java.lang.String getQualifiedPointId()
          Returns an Id of the extension point that is defined in this schema.

int getResolvedElementCount()
          Returns a total number of elements after the included schemas have been resolved and their elements added to the list.

ISchemaElement[] getResolvedElements()
          Returns an array of elements with the global scope defined in this schema and all the included schemas.

ISchemaDescriptor getSchemaDescriptor()
          Returns an object that holds a reference to this schema.

java.net.URL getURL()
          Returns a URL that defines this schema's location.

void setPluginId(java.lang.String pluginId)


void setPointId(java.lang.String pointId)


Methods inherited from interface org.eclipse.pde.internal.core.ischema.ISchemaObject

getDescription, getName, getParent, getSchema, setParent

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.pde.core.IWritable

write

Methods inherited from interface org.eclipse.pde.core.IBaseModel

dispose, isDisposed, isEditable, isValid

Methods inherited from interface org.eclipse.pde.core.IModelChangeProvider

addModelChangedListener, fireModelChanged, fireModelObjectChanged, removeModelChangedListener

Field Detail

P_POINT

public static final java.lang.String P_POINT

See Also:: Constant Field Values

P_PLUGIN

public static final java.lang.String P_PLUGIN

See Also:: Constant Field Values

REFRESH_ADD

public static final int REFRESH_ADD

See Also:: Constant Field Values

REFRESH_DELETE

public static final int REFRESH_DELETE

See Also:: Constant Field Values

REFRESH_RENAME

public static final int REFRESH_RENAME

See Also:: Constant Field Values

Method Detail

findElement

public ISchemaElement findElement(java.lang.String name)

Returns a reference to a schema element defined in this schema or null if not found.

getCandidateChildren

public ISchemaElement[] getCandidateChildren(ISchemaElement element)

Returns an array of schema elements that can be children of the provided schema element. The information is computed based on the grammar rules in this schema. The computation ignores number of occurances of each element. Therefore, it will always return the same result even if there could be only one element of a certain type in the document and it already exists.

getDocumentSections

public IDocumentSection[] getDocumentSections()

Returns an array of document sections that are defined in this schema.

getElementCount

public int getElementCount()

Returns a number of elements with global scope defined in this schema.

getResolvedElementCount

public int getResolvedElementCount()

Returns a total number of elements after the included schemas have been resolved and their elements added to the list.

getElements

public ISchemaElement[] getElements()

Returns an array of elements with the global scope defined in this schema.

getResolvedElements

public ISchemaElement[] getResolvedElements()

Returns an array of elements with the global scope defined in this schema and all the included schemas.

getQualifiedPointId

public java.lang.String getQualifiedPointId()

Returns an Id of the extension point that is defined in this schema.

getPointId

public java.lang.String getPointId()

setPointId

public void setPointId(java.lang.String pointId)
                throws org.eclipse.core.runtime.CoreException

getPluginId

public java.lang.String getPluginId()

setPluginId

public void setPluginId(java.lang.String pluginId)
                 throws org.eclipse.core.runtime.CoreException

getSchemaDescriptor

public ISchemaDescriptor getSchemaDescriptor()

Returns an object that holds a reference to this schema. Descriptors are responsible for loading and disposing schema objects and could be implemented in various ways, depending on whether the schema is defined inside the workspace or is referenced externally.

getURL

public java.net.URL getURL()

Returns a URL that defines this schema's location.

getIncludes

public ISchemaInclude[] getIncludes()

Returns a list of elements that correspond to the include statements in the schema file. Included schemas are incorporated into the model and references can be made to elements in the included files.