Module platform.core

Package de.grogra.pf.registry

Class PluginDescriptor

java.lang.Object

de.grogra.graph.impl.Edge

de.grogra.graph.impl.Node

de.grogra.pf.registry.Item

de.grogra.pf.registry.PluginDescriptor

All Implemented Interfaces:

Manageable, PersistenceCapable, Shareable, RegistryContext, UserFields, XObject, Described, Map, Serializable, Comparable<PluginDescriptor>

public final class PluginDescriptor
extends Item
implements Comparable<PluginDescriptor>

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.grogra.graph.impl.Node

Node.AccessorBridge, Node.FieldAttributeAccessor, Node.NType

Nested classes/interfaces inherited from interface de.grogra.util.Map

Map.Chain

Field Summary

Fields

Modifier and Type	Field	Description
static final Node.NType	$TYPE
static final int	ACTIVE
static final Node.NType.Field	cls$FIELD
static final int	CONFLICT_WITH_PLUGIN
static final int	DISABLED
static final int	ERROR
static final int	FRESH
static final int	INACTIVE
static final int	MISSING_PREREQUISITE
static final Node.NType.Field	version$FIELD

Fields inherited from class de.grogra.pf.registry.Item

systemId, systemId$FIELD

Fields inherited from class de.grogra.graph.impl.Node

ADDITIONAL_FIELDS, bits, DELETED, EXTENT_BIT, EXTENT_MASK, extentIndex$FIELD, extentTail$FIELD, HAS_OBSERVERS, IS_INTERPRETIVE, isInterpretive$FIELD, LAST_EXTENT_INDEX, layer$FIELD, MARK, mark$FIELD, MAX_RESOLUTION, MIME_TYPE, MIN_RESOLUTION, MIN_UNUSED_SPECIAL_OF_SOURCE, MIN_UNUSED_SPECIAL_OF_TARGET, name$FIELD, RESOLUTION_BIT, RESOLUTION_MASK, resolution$FIELD, USED_BITS

Fields inherited from interface de.grogra.util.Described

ACCELERATOR_KEY, ICON, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, TITLE

Fields inherited from interface de.grogra.util.Map

DEFAULT_VALUE, EMPTY_MAP

Method Summary

Modifier and Type	Method	Description
protected void	addExtensionToRegistry()	Add the EXT folder to the registry for it to be loaded before the core.
protected static void	addJarToMap(Map<String,File> m, File root)
protected static int	compareExtVersion(String o1, String o2)	To compare the extensions versions
int	compareTo(PluginDescriptor o)	First take the plugin descriptor from the highest directory priority (the user parameter plugin > the groimp installation folder > the pm plugin repo).
static PluginDescriptor	createCoreDescriptor(ObjectList<File> libDir)
static PluginDescriptor	createCoreDescriptor(File libDir)
Object	get(Object key, Object defaultValue)	Returns the value associated with key.
ClassLoader	getClassLoader()
File	getConfigurationDirectory()
protected static String	getExtVersion(String name)
FileSystem	getFileSystem()
I18NBundle	getI18NBundle()
static PluginDescriptor	getInstance(Class cls)
static PluginDescriptor	getInstance(ClassLoader loader)
static PluginDescriptor	getInstance(String pluginId)
String[]	getLibrariesNames()	Return the library (item) name, even if the library has not been loaded (thus the file is null).
Object[]	getLibraryFiles()
protected Node.NType	getNTypeImpl()	This method returns the Node.NType which describes the managed fields of the class of this node.
Plugin	getPlugin()
PluginClassLoader	getPluginClassLoader()
Object	getPluginDirectory()
String	getPluginName()
String	getPluginProvider()
int	getPluginState()
String	getPluginVersion()
URL	getURLForResource(String name)
void	loadMethodsDoc()
void	loadMethodsDoc(URL u)
boolean	loadPlugin(Registry registry, ClassLoader parentLoader)
protected Node	newInstance()	This method returns a new instance of the class of this node.
static PluginDescriptor	read(String systemId, InputStream in, FileSystem fs, Object dir)
protected boolean	readAttribute(String uri, String name, String value)
void	setI18NBundle(I18NBundle bundle)
void	setPluginState(int state)
String	toString()

Methods inherited from class de.grogra.pf.registry.Item

activate, activateImpl, add, add, addPluginPrerequisite, addPluginPrerequisites, addRequiredFiles, addUserItem, addUserItemWithUniqueName, addWithUniqueName, beginXA, classForName, commitXA, copy, createItem, deactivate, deactivateImpl, delete, deriveItems, dupUnmanagedFields, equals, findAll, findAll, findAll, findFirst, findFirst, findFirst, findMax, findMax, findMax, forAll, forAll, forAll, getAbsoluteName, getAccessor, getAccessor, getAttributes, getAttributes, getDefaultDescription, getDefaultValue, getDerivedDescription, getDescription, getDescriptionImpl, getFromResource, getItem, getLock, getParentMap, getPath, getPluginDescriptor, getRegistry, getRoot, getSystemId, getTransaction, getUniqueName, getWriteLock, hasEditableOptions, initPluginDescriptor, isActivated, isDirectory, isEditable, isOptionCategory, isPluginItem, isUserItem, makeUserItem, paramString, remove, removeDerivedItems, resolveItem, resolveLink, set, setDefaultDescription, setDescription, setDescription, setDirectory, setName, setNameIfNull, setOption, substitute, validate

Methods inherited from class de.grogra.graph.impl.Node

addEdgeBitsTo, addReference, appendBranchNode, appendBranchNode, appendReferencesTo, clone, clone, cloneGraph, dump, dumpTree, dup, dupFrom, dupnew, edgeChanged, fieldModified, findAdjacent, findRefinementType, getAxisParent, getBoolean, getBranch, getBranchLength, getBranchNode, getBranchTail, getByte, getChar, getCommonAncestor, getCurrentGraphState, getDirectChildCount, getDouble, getEdgeAttributeAccessor, getEdgeAttributes, getEdgeBitsTo, getEdgeTo, getExtentIndex, getFirst, getFirstEdge, getFloat, getGraph, getId, getIgnored, getIndex, getInstantiator, getInt, getLayer, getLong, getManageableType, getName, getNeighbor, getNext, getNType, getObject, getOrCreateEdgeTo, getOrNull, getPersistenceManager, getPredecessor, getProvider, getResolution, getShort, getSource, getStamp, getSuccessor, getSymbol, getSymbolColor, getTarget, getTransaction, getUserField, getUserFieldCount, getXClass, getXData, hasName, initProvider, initXClass, insertBranchNode, insertBranchNode, instantiateGraph, isAncestorOf, isDirection, isEncoarseOf, isManagingInstance, isMarked, isRoot, isSource, isTarget, manageableReadResolve, manageableWriteReplace, removeAll, removeEdgeBitsTo, removeFromChain, removeFromChain, removeReference, setBranch, setBranch, setExtentIndex, setGraphForDeserialization, setIgnored, setLayer, setMark, setResolution, setSuccessor, setSuccessor, specialEdgeAdded, specialEdgeRefModified, specialEdgeRemoved, writeReplace

Methods inherited from class de.grogra.graph.impl.Edge

addEdgeBits, getBitMark, getEdgeBits, getEdgeKeys, getObjectMark, getSpecialEdgeDescriptor, parseEdgeKeys, remove, removeEdgeBits, setBitMark, setEdgeBits, setObjectMark, testEdgeBits

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.grogra.persistence.PersistenceCapable

getBitMark, getObjectMark, setBitMark, setObjectMark

Field Details

FRESH

public static final int FRESH

See Also:

• Constant Field Values

DISABLED

public static final int DISABLED

See Also:

• Constant Field Values

ERROR

public static final int ERROR

See Also:

• Constant Field Values

MISSING_PREREQUISITE

public static final int MISSING_PREREQUISITE

See Also:

• Constant Field Values

INACTIVE

public static final int INACTIVE

See Also:

• Constant Field Values

ACTIVE

public static final int ACTIVE

See Also:

• Constant Field Values

CONFLICT_WITH_PLUGIN

public static final int CONFLICT_WITH_PLUGIN

See Also:

• Constant Field Values

$TYPE

public static final Node.NType $TYPE

version$FIELD

public static final Node.NType.Field version$FIELD

cls$FIELD

public static final Node.NType.Field cls$FIELD

Method Details

getNTypeImpl

protected Node.NType getNTypeImpl()

Description copied from class: Node

This method returns the Node.NType which describes the managed fields of the class of this node. This method has to be implemented in every concrete subclass.

Overrides:

getNTypeImpl in class Item

Returns:

type describing the managed fields of the class of this node

newInstance

protected Node newInstance()

Description copied from class: Node

This method returns a new instance of the class of this node. This method has to be implemented in every concrete subclass.

Overrides:

newInstance in class Item

Returns:

new instance of class of this node

createCoreDescriptor

public static PluginDescriptor createCoreDescriptor(File libDir)

createCoreDescriptor

public static PluginDescriptor createCoreDescriptor(ObjectList<File> libDir)

addJarToMap

protected static void addJarToMap(Map<String,File> m,
 File root)

getPluginVersion

public String getPluginVersion()

getPluginName

public String getPluginName()

getPluginProvider

public String getPluginProvider()

get

public Object get(Object key,
 Object defaultValue)

Description copied from interface: Map

Returns the value associated with key. If there is no value associated with key, defaultValue is returned.

Specified by:

get in interface Map

Overrides:

get in class Item

Parameters:

key - a key for the map

defaultValue - the default value

Returns:

the associated value, or defaultValue

readAttribute

protected boolean readAttribute(String uri,
 String name,
 String value)
                         throws SAXException

Overrides:

readAttribute in class Item

Throws:

SAXException

read

public static PluginDescriptor read(String systemId,
 InputStream in,
 FileSystem fs,
 Object dir)
                             throws IOException

Throws:

IOException

loadPlugin

public boolean loadPlugin(Registry registry,
 ClassLoader parentLoader)

addExtensionToRegistry

protected void addExtensionToRegistry()

Add the EXT folder to the registry for it to be loaded before the core.

getPluginDirectory

public Object getPluginDirectory()

getFileSystem

public FileSystem getFileSystem()

setPluginState

public void setPluginState(int state)

getPluginState

public int getPluginState()

getPlugin

public Plugin getPlugin()

toString

public String toString()

Overrides:

toString in class Node

getI18NBundle

public I18NBundle getI18NBundle()

Overrides:

getI18NBundle in class Item

setI18NBundle

public void setI18NBundle(I18NBundle bundle)

getLibraryFiles

public Object[] getLibraryFiles()

getClassLoader

public ClassLoader getClassLoader()

Overrides:

getClassLoader in class Item

getPluginClassLoader

public PluginClassLoader getPluginClassLoader()

getURLForResource

public URL getURLForResource(String name)

getInstance

public static PluginDescriptor getInstance(String pluginId)

getInstance

public static PluginDescriptor getInstance(Class cls)

getInstance

public static PluginDescriptor getInstance(ClassLoader loader)

getConfigurationDirectory

public File getConfigurationDirectory()

loadMethodsDoc

public void loadMethodsDoc()

loadMethodsDoc

public void loadMethodsDoc(URL u)

compareTo

public int compareTo(PluginDescriptor o)

First take the plugin descriptor from the highest directory priority (the user parameter plugin > the groimp installation folder > the pm plugin repo). If they are the same, take the higher version.

Specified by:

compareTo in interface Comparable<PluginDescriptor>

compareExtVersion

protected static int compareExtVersion(String o1,
 String o2)

To compare the extensions versions

getExtVersion

protected static String getExtVersion(String name)

getLibrariesNames

public String[] getLibrariesNames()

Return the library (item) name, even if the library has not been loaded (thus the file is null).