org.eclipse.update.core
Class BaseSiteFactory

java.lang.Object
  |
  +--org.eclipse.update.core.model.SiteModelFactory
        |
        +--org.eclipse.update.core.BaseSiteFactory

All Implemented Interfaces:

ISiteFactory

public abstract class BaseSiteFactory

extends SiteModelFactory

implements ISiteFactory

Base implementation of a site factory. The factory is responsible for constructing the correct concrete implementation of the model objects for each particular site type. This class creates model objects that correspond to the concrete implementation classes provided in this package. The actual site creation method is subclass responsibility.

This class must be subclassed by clients.

Since:

2.0

See Also:

ISiteFactory, SiteModelFactory

Constructor Summary

BaseSiteFactory()

Method Summary

ArchiveReferenceModel	createArchiveReferenceModel() Create a concrete implementation of archive reference model.
FeatureReferenceModel	createFeatureReferenceModel() Create a concrete implementation of feature reference model.
abstract ISite	createSite(URL url) Create site.
CategoryModel	createSiteCategoryModel() Create a concrete implementation of category model.
SiteModel	createSiteMapModel() Create a concrete implementation of site model.
URLEntryModel	createURLEntryModel() Create a concrete implementation of annotated URL model.
protected ResourceBundle	getResourceBundle(URL url) Helper method to access resouce bundle for site.

Methods inherited from class org.eclipse.update.core.model.SiteModelFactory

canParseSiteType, parseSite

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseSiteFactory

public BaseSiteFactory()

Method Detail

createSite

public abstract ISite createSite(URL url)
                          throws CoreException,
                                 InvalidSiteTypeException

Create site. Implementation of this method must be provided by subclass

Specified by:

createSite in interface ISiteFactory

Parameters:

url - URL interpreted by the site

Returns:

site object

Throws:

InvalidSiteTypeException - the referenced site type is not a supported type for this factory

CoreException

Since:

2.0

See Also:

ISiteFactory.createSite(URL)

getResourceBundle

protected ResourceBundle getResourceBundle(URL url)

Helper method to access resouce bundle for site. The default implementation attempts to load the appropriately localized site.properties file.

Parameters:

url - base URL used to load the resource bundle.

Returns:

resource bundle, or null.

Since:

2.0

createSiteMapModel

public SiteModel createSiteMapModel()

Create a concrete implementation of site model.

Overrides:

createSiteMapModel in class SiteModelFactory

Returns:

site model

Since:

2.0

See Also:

Site

createFeatureReferenceModel

public FeatureReferenceModel createFeatureReferenceModel()

Create a concrete implementation of feature reference model.

Overrides:

createFeatureReferenceModel in class SiteModelFactory

Returns:

feature reference model

Since:

2.0

See Also:

FeatureReference

createArchiveReferenceModel

public ArchiveReferenceModel createArchiveReferenceModel()

Create a concrete implementation of archive reference model.

Overrides:

createArchiveReferenceModel in class SiteModelFactory

Returns:

archive reference model

Since:

2.0

See Also:

ArchiveReference

createURLEntryModel

public URLEntryModel createURLEntryModel()

Create a concrete implementation of annotated URL model.

Overrides:

createURLEntryModel in class SiteModelFactory

Returns:

annotated URL model

Since:

2.0

See Also:

URLEntry

createSiteCategoryModel

public CategoryModel createSiteCategoryModel()

Create a concrete implementation of category model.

Overrides:

createSiteCategoryModel in class SiteModelFactory

Returns:

category model

Since:

2.0

See Also:

Category