AbstractLibrary

java.lang.Object
- org.gvsig.tools.library.AbstractLibrary

All Implemented Interfaces:

Library

Direct Known Subclasses:

AboutDefaultImplLibrary, AboutLibrary, AddGeometryEditingLibrary, AlgorithmAbstractLibrary, AlgorithmSwingImplLibrary, AlgorithmSwingLibrary, AlignEdgesEditingLibrary, AnnotationDefaultImplLibrary, AnnotationLibrary, AnnotationSwingDefaultImplLibrary, AnnotationSwingLibrary, ApplicationLibrary, ApplicationLibraryImpl, ArcEditingLibrary, AutopolygonEditingLibrary, BasicDynFormFieldsLibrary, BasicLayerOrderLibrary, BasicMetadataLibrary, BasicMetadataSwingLibrary, BingMapsLibrary, BingMapsProviderLibrary, BingMapsSwingLibrary, BSQLibrary, BufferCacheLibrary, BufferLibrary, CatalogLibrary, ChamferEditingLibrary, Circle3PEditingLibrary, CircleCREditingLibrary, ClipAlgorithmLibrary, CombineEditingLibrary, CompatLibrary, ComplexLegendLibrary, ComplexLegendSwingLibrary, ConvertToPolylineLibrary, CresquesCtsLibrary, CresquesCtsUILibrary, CSVLibrary, DALDbLibrary, DALDefaultImplLibrary, DALFileLibrary, DALGPELibrary, DALLibrary, DALSwingLibrary, DataTransformLibrary, DBFLibrary, DBResourceLibrary, DBStoreLibrary, DefaultBingMapsLibrary, DefaultBingMapsSwingLibrary, DefaultBufferLibrary, DefaultCacheIOLibrary, DefaultCatalogLibrary, DefaultComplexLegendLibrary, DefaultComplexLegendSwingLibrary, DefaultDALSwingLibrary, DefaultDataTransformLibrary, DefaultDerivedGeometriesLibrary, DefaultDynFormLibrary, DefaultEditingLibrary, DefaultEditingProviderLibrary, DefaultEditingSwingLibrary, DefaultErmapperIOLibrary, DefaultGazetteerLibrary, DefaultGdalIOLibrary, DefaultGeometryLibrary, DefaultGeometryOperationLibrary, DefaultGoogleMapsLibrary, DefaultGoogleMapsSwingLibrary, DefaultGPELibrary, DefaultGPEProviderLibrary, DefaultInstallerLibrary, DefaultLizardtechIOLibrary, DefaultMapControlLibrary, DefaultMultiFileIOLibrary, DefaultNetCDFIOLibrary, DefaultOSMIOLibrary, DefaultOSMSwingLibrary, DefaultPostGISRasterIOLibrary, DefaultPublishLibrary, DefaultPublishSwingLibrary, DefaultSeismicLibrary, DefaultSeismicSwingLibrary, DefaultSwingInstallerLibrary, DefaultWCSIOLibrary, DefaultWebMapLibrary, DefaultWMSIOLibrary, DefaultWMTSIOLibrary, DerivedGeometriesLibrary, DGNLegendLibrary, DGNLibrary, DownloaderLibrary, DownloaderLibraryImpl, DownloaderSwingImplLibrary, DownloaderSwingLibrary, DownloaderSwingScribejavaLibrary, DuplicateEditingLibrary, DWGLegendLibrary, DWGLibrary, DXFLegendLibrary, DXFLibrary, DynFormLibrary, DynFormSPILibrary, DyschromatopsiaDefaultImplLibrary, DyschromatopsiaLibrary, DyschromatopsiaSwingDefaultImplLibrary, DyschromatopsiaSwingLibrary, EditingLibrary, EditingProviderLibrary, EditingSwingLibrary, EditVertexEditingLibrary, EllipseEditingLibrary, EventThemeTransformLibrary, ExplodeEditingLibrary, ExportCSVLibrary, ExportDBFLibrary, ExportDXFLibrary, ExportJDBCLibrary, ExportKMLLibrary, ExportLibrary, ExportLibraryImpl, ExportShapeLibrary, ExportSwingLibrary, ExportSwingLibraryImpl, ExporttoGPEGenericLibrary, ExpressionEvaluatorImplLibrary, ExpressionEvaluatorLibrary, ExpressionEvaluatorSwingLibrary, ExpressionEvaluatorSwingLibraryImpl, ExtendLineEditingLibrary, FmapRasterLibrary, GazetteerLibrary, GeometryExpressionEvaluatorImplLibrary, GeometryExpressionEvaluatorLibrary, GeometryLibrary, GeoProcessLibrary, GeoreferencingDefaultImplLibrary, GeoreferencingLibrary, GeoreferencingSwingImplLibrary, GeoreferencingSwingLibrary, GmlLibrary, GMLLibrary, GMLLibrary, GoogleMapsLibrary, GoogleMapsProviderLibrary, GoogleMapsSwingLibrary, GPELibrary, H2SpatialLibrary, InstallerLibrary, InternalPolygonEditingLibrary, IverUtilesLibrary, JCRSCoordinateReferenceSystemLibrary, JCRSLibrary, JCRSPluginLibrary, JDBCLibrary, JExcelLibrary, JoinEditingLibrary, JoinTransformLibrary, JP2Library, JpgLibrary, JsonLibrary, KmlLibrary, KMLLibrary, LayerDatatypeAlgorithmLibrary, LineEditingLibrary, MapContextGeomOperationsLibrary, MapContextImplLibrary, MapContextLibrary, MapContextRasterLibrary, MapContextRasterSwingLibrary, MapControlLibrary, MapproxyLibrary, MapproxySwingLibrary, MapserverLibrary, MapserverSwingLibrary, MaskthresholdAlgorithmLibrary, MDBLibrary, MemoryStoreLibrary, MessagesLibrary, MetadataLibrary, MetadataSwingLibrary, MoveEditingLibrary, MultipointEditingProviderLibrary, NewLayerCSVProviderLibrary, NewLayerDefaultImplLibrary, NewLayerFileProviderLibrary, NewLayerJDBCProviderLibrary, NewLayerLibrary, NewLayerShapeProviderLibrary, OffsetEditingLibrary, OGRLibrary, OGRLibrary, OSMSwingLibrary, ParabolicFilletEditingLibrary, PluginInstallerProviderLibrary, PluginsLibrary, PngLibrary, PointEditingLibrary, PolarMatrixEditingLibrary, PolylineEditingLibrary, PortableViewDefaultImplLibrary, PortableViewEditorDefaultImplLibrary, PortableViewEditorLibrary, PortableViewInstallerProviderLibrary, PortableViewLibrary, PortableViewSwingDefaultImplLibrary, PortableViewSwingLibrary, PostGISRasterSwingImplLibrary, PostGISRasterSwingLibrary, PostgreSQLLibrary, PrincipalComponentsAlgorithmLibrary, PrincipalComponentsDefaultSwingImplLibrary, PrincipalComponentsSwingLibrary, ProjectionLibrary, PublishLibrary, PublishSwingLibrary, RasterBaseAlgorithmLibrary, RasterDefaultImplLibrary, RasterLegendLibrary, RasterLibrary, RasterLibrary, RasterReprojectionAlgorithmLibrary, RasterSwingBufferLibrary, RasterSwingImplLibrary, RasterSwingLegendLibrary, RasterSwingLibrary, RasterToolsLibrary, RasterToolsSwingLibrary, RectangleEditingLibrary, RectangularMatrixEditingLibrary, RegularPolygonEditingLibrary, RemoveEditingLibrary, ReverseDirectionEditingLibrary, ROIMaskAlgorithmLibrary, ROIMaskDefaultImplLibrary, ROIMaskDefaultSwingImplLibrary, ROIMaskLibrary, ROIMaskSwingLibrary, ROIMaskToolboxLibrary, RotateEditingLibrary, SaveRasterAlgorithmLibrary, ScaleEditingLibrary, ScriptingDefaultImplLibrary, ScriptingLibrary, ScriptingSwingDefaultSwingLibrary, ScriptingSwingLibrary, SECompatLibrary, SeismicLibrary, SeismicStoreProviderLibrary, SeismicSwingLibrary, SextanteGeoProcessLibrary, SHPLibrary, SimplifyEditingLibrary, SLDConverterDefaultLibrary, SLDConverterLibrary, SLDSupportDefaultLibrary, SLDSupportLibrary, SmoothLineEditingLibrary, SplineEditingLibrary, SplitEditingLibrary, SplitLineEditingLibrary, SQLiteLibrary, SQLJEPLibrary, StretchEditingLibrary, SwingInstallerLibrary, SwipeSwingImplLibrary, SwipeSwingLibrary, SymbolInstallerProviderLibrary, SymbologyDefaultImplLibrary, SymbologyLibrary, SymbologySwingDefaultImplLibrary, SymbologySwingLibrary, SymmetryEditingLibrary, TasseledCapAlgorithmLibrary, TasseledCapDefaultSwingImplLibrary, TasseledCapSwingLibrary, TemporaryStorageImplLibrary, TemporaryStorageLibrary, TiffLibrary, TileCacheDefaultImplLibrary, TileCacheLegendLibrary, TileCacheLibrary, TileCacheLibrary, TimeExpressionEvaluatorImplLibrary, TimeSupportDefaultImplLibrary, TimeSupportLibrary, TimeSupportSwingLibrary, ToolboxAlgorithmLibrary, ToolboxCoreLibrary, ToolboxGUILibrary, ToolsLibrary, ToolsSwingDefaultImplLibrary, ToolsSwingLibrary, ToolsUtilLibrary, ToolsUtilLibraryImpl, TrimLineEditingLibrary, UILibraryImpl, WebMapLibrary, WFSLibrary, WMTSOGCDefaultImplLibrary, WMTSOGCLibrary, WMTSSwingImplLibrary, WMTSSwingLibrary, Xml2dbImplLibrary, Xml2dbLibrary, Xml2dbSwingImplLibrary, Xml2dbSwingLibrary, XmlLibrary, XMLPersistenceLibrary
```
public abstract class AbstractLibrary
extends java.lang.Object
implements Library
```
Base Library implementation, checking that a Library is initialized and postInitialized only once. Also adds initialization logging.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractLibrary.DefaultRequired
Association between a library class and its type.
- Nested classes/interfaces inherited from interface org.gvsig.tools.library.Library
  Library.Required, Library.TYPE

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractLibrary.DefaultRequired` Association between a library class and its type.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractLibrary()` Empty constructor.
`protected`	`AbstractLibrary(java.lang.Class library, int priority)` Deprecated. to be removed in the 4.x version. Use the `AbstractLibrary()` empty constructor and override the `doRegistration()` method instead.
`protected`	`AbstractLibrary(java.lang.Class library, java.lang.String type)` Deprecated. to be removed in the 4.x version. Use the `AbstractLibrary()` empty constructor and override the `doRegistration()` method instead.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected abstract void`	`doInitialize()` Performs all the initializations of the library, only related to himself: register implementation classes through the Locator, start services, etc.
`protected abstract void`	`doPostInitialize()` Performs all the initializations or validations related to the library dependencies, as getting references to objects through other libraries Locators.
`void`	`doRegistration()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Class`	`getLibrary()` Returns the name of the current Library
`int`	`getPriority()` Returns a priority number to range this implementation in case multiple ones are within the libraries initialization.
`java.util.Set`	`getRequireds()` Returns a Set of required libraries and their types.
`java.lang.String`	`getType()` Returns the type of the Library.
`int`	`hashCode()`
`void`	`initialize()` Performs all the initializations of the library, only related to himself: register implementation classes through the Locator, start services, etc.
`boolean`	`isRequired(java.lang.Class libClass)` Returns if a given library class is required.
`boolean`	`isRequired(Library lib)` Returns if a given library is required.
`void`	`postInitialize()` Performs all the initializations or validations related to the library dependencies, as getting references to objects through other libraries Locators.
`protected void`	`registerAs(java.lang.Class library, java.lang.String type)` Registers the library with type of library it is: API or implementation of a library.
`protected void`	`registerAsAPI(java.lang.Class library)` Registers the library as an API one.
`protected void`	`registerAsImplementationOf(java.lang.Class library)` Registers the library as an implementation of an API library, with the default priority.
`protected void`	`registerAsImplementationOf(java.lang.Class library, int priority)` Registers the library as an implementation of an API library.
`protected void`	`registerAsServiceOf(java.lang.Class library)` Registers the library as a service or provider of an API library.
`void`	`require(java.lang.Class library)` Adds a required library, so it is initialized before the current one.
`void`	`require(java.lang.Class library, java.lang.String type)` Deprecated. use the `require(Class)` method instead, as you may have problems if the type specified is not correct. Moreover, this is not needed.
`void`	`require(java.util.Collection<Library.Required> libraries)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AbstractLibrary
```
protected AbstractLibrary()
```
    Empty constructor.
  - AbstractLibrary
```
protected AbstractLibrary(java.lang.Class library,
                          java.lang.String type)
```
    Deprecated. to be removed in the 4.x version. Use the AbstractLibrary() empty constructor and override the doRegistration() method instead.
    
    Creates a new library registering with type of library it is: API or implementation of a library.
    When it is an API library, the class will be itself.
    
    Parameters:
    
    library - the library class we relate to
    
    type - the library type. See TYPE.
    
    See Also:
    
    AbstractLibrary()
  - AbstractLibrary
```
protected AbstractLibrary(java.lang.Class library,
                          int priority)
```
    Deprecated. to be removed in the 4.x version. Use the AbstractLibrary() empty constructor and override the doRegistration() method instead.
    
    Creates a new library registering it as an implementation. A priority is also provided just in case there is another implementation available, so the one with the highest priority will be the one used.
    
    Parameters:
    
    library - the library class we relate to
    
    priority - the priority of the library against other implementations of the same library
    
    See Also:
    
    AbstractLibrary()
- Method Detail
  - getRequireds
```
public java.util.Set getRequireds()
```
    Description copied from interface: Library
    
    Returns a Set of required libraries and their types.
    
    Specified by:
    
    getRequireds in interface Library
    
    Returns:
    
    a Set of required libraries
  - getLibrary
```
public java.lang.Class getLibrary()
```
    Returns the name of the current Library
    
    Specified by:
    
    getLibrary in interface Library
    
    Returns:
    
    the Library class this library is related to
  - getType
```
public java.lang.String getType()
```
    Description copied from interface: Library
    
    Returns the type of the Library.
    
    Specified by:
    
    getType in interface Library
    
    Returns:
    
    See Also:
    
    TYPE.
  - getPriority
```
public int getPriority()
```
    Description copied from interface: Library
    
    Returns a priority number to range this implementation in case multiple ones are within the libraries initialization.
    
    Specified by:
    
    getPriority in interface Library
    
    Returns:
    
    a priority number, 0 by default.
  - require
```
public final void require(java.lang.Class library,
                          java.lang.String type)
```
    Deprecated. use the require(Class) method instead, as you may have problems if the type specified is not correct. Moreover, this is not needed.
    
    Adds a required library, so it is initialized before the current one.
    
    Parameters:
    
    library - the required library
    
    type - the type of the required library
  - require
```
public final void require(java.lang.Class library)
```
    Adds a required library, so it is initialized before the current one.
    
    Specified by:
    
    require in interface Library
    
    Parameters:
    
    library - the required library
  - require
```
public final void require(java.util.Collection<Library.Required> libraries)
```
    Specified by:
    
    require in interface Library
  - registerAs
```
protected final void registerAs(java.lang.Class library,
                                java.lang.String type)
```
    Registers the library with type of library it is: API or implementation of a library.
    When it is an API library, the class will be itself.
    
    Parameters:
    
    library - the library class we relate to
    
    type - the library type. See TYPE.
  - registerAsAPI
```
protected final void registerAsAPI(java.lang.Class library)
```
    Registers the library as an API one.
    
    Parameters:
    
    library - the library class we relate to
  - registerAsImplementationOf
```
protected final void registerAsImplementationOf(java.lang.Class library)
```
    Registers the library as an implementation of an API library, with the default priority.
    
    Parameters:
    
    library - the library class we relate to
  - registerAsImplementationOf
```
protected final void registerAsImplementationOf(java.lang.Class library,
                                                int priority)
```
    Registers the library as an implementation of an API library. A priority is also provided just in case there is another implementation available, so the one with the highest priority will be the one used.
    
    Parameters:
    
    library - the library class we relate to
    
    priority - the priority of the library against other implementations of the same library
  - registerAsServiceOf
```
protected final void registerAsServiceOf(java.lang.Class library)
```
    Registers the library as a service or provider of an API library.
    
    Parameters:
    
    library - the library class we relate to
  - initialize
```
public final void initialize()
                      throws LibraryException
```
    Description copied from interface: Library
    
    Performs all the initializations of the library, only related to himself: register implementation classes through the Locator, start services, etc.
    
    Specified by:
    
    initialize in interface Library
    
    Throws:
    
    LibraryException - if there is an error while performing the initialization of the library
  - postInitialize
```
public final void postInitialize()
                          throws LibraryException
```
    Description copied from interface: Library
    
    Performs all the initializations or validations related to the library dependencies, as getting references to objects through other libraries Locators.
    
    Specified by:
    
    postInitialize in interface Library
    
    Throws:
    
    LibraryException - if there is an error while loading an implementation of the library
  - doRegistration
```
public void doRegistration()
```
    Specified by:
    
    doRegistration in interface Library
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - isRequired
```
public boolean isRequired(Library lib)
```
    Description copied from interface: Library
    
    Returns if a given library is required.
    
    Specified by:
    
    isRequired in interface Library
    
    Parameters:
    
    lib - the library to check if it is required
    
    Returns:
    
    if is required
  - isRequired
```
public boolean isRequired(java.lang.Class libClass)
```
    Description copied from interface: Library
    
    Returns if a given library class is required.
    
    Specified by:
    
    isRequired in interface Library
    
    Parameters:
    
    libClass - the library Class to check if it is required
    
    Returns:
    
    if is required
  - doInitialize
```
protected abstract void doInitialize()
                              throws LibraryException
```
    Performs all the initializations of the library, only related to himself: register implementation classes through the Locator, start services, etc.
    
    Throws:
    
    LibraryException - if there is an error while performing the initialization of the library
  - doPostInitialize
```
protected abstract void doPostInitialize()
                                  throws LibraryException
```
    Performs all the initializations or validations related to the library dependencies, as getting references to objects through other libraries Locators.
    
    Throws:
    
    LibraryException - if there is an error while loading an implementation of the library

Class AbstractLibrary

Nested Class Summary

Nested classes/interfaces inherited from interface org.gvsig.tools.library.Library

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractLibrary

AbstractLibrary

AbstractLibrary

Method Detail

getRequireds

getLibrary

getType

getPriority

require

require

require

registerAs

registerAsAPI

registerAsImplementationOf

registerAsImplementationOf

registerAsServiceOf

initialize

postInitialize

doRegistration

equals

hashCode

toString

isRequired

isRequired

doInitialize

doPostInitialize