org.eclipse.equinox.internal.p2.updatesite

Class SiteXMLAction

java.lang.Object

AbstractPublisherAction

org.eclipse.equinox.internal.p2.updatesite.SiteXMLAction

Direct Known Subclasses:

CategoryXMLAction

public class SiteXMLAction
extends AbstractPublisherAction

Action which processes a site.xml and generates categories. The categorization process relies on IUs for the various features to have already been generated.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.net.URI	location
protected UpdateSite	updateSite

Constructor Summary

Constructors

Constructor and Description
SiteXMLAction(UpdateSite updateSite, java.lang.String categoryQualifier) Creates a SiteXMLAction from an Update site with an optional qualifier to use for category names
SiteXMLAction(java.net.URI location, java.lang.String categoryQualifier) Creates a SiteXMLAction from a Location (URI) with an optional qualifier to use for category names

Method Summary

Modifier and Type	Method and Description
IInstallableUnit	createCategoryIU(SiteCategory category, java.util.Set<IInstallableUnit> childrenIUs) Creates an IU corresponding to an update site category
IInstallableUnit	createCategoryIU(SiteCategory category, java.util.Set<IInstallableUnit> childrenIUs, IInstallableUnit nestedCategory) Deprecated. use IInstallableUnitcreateCategoryIU(SiteCategory, Set) instead
protected VersionRange	createVersionRange(java.lang.String versionId)
protected void	generateCategoryIUs(java.util.Map<SiteCategory,java.util.Set<IInstallableUnit>> categoriesToIUs, IPublisherResult result) Generates IUs corresponding to update site categories.
protected java.util.Map<SiteBundle,java.util.Set<SiteCategory>>	getBundleToCategoryMappings(IPublisherInfo publisherInfo) Computes the mapping of bundles to categories as defined in the site.xml, if available.
protected java.util.Map<SiteFeature,java.util.Set<SiteCategory>>	getFeatureToCategoryMappings(IPublisherInfo publisherInfo) Computes the mapping of features to categories as defined in the site.xml, if available.
protected Transport	getTransport(IPublisherInfo info)
IStatus	perform(IPublisherInfo publisherInfo, IPublisherResult results, IProgressMonitor monitor)
void	setCategoryVersion(java.lang.String version)

Methods inherited from class java.lang.Object

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

Field Detail

updateSite

protected UpdateSite updateSite

location

protected java.net.URI location

Constructor Detail

SiteXMLAction

public SiteXMLAction(java.net.URI location,
                     java.lang.String categoryQualifier)

Creates a SiteXMLAction from a Location (URI) with an optional qualifier to use for category names

Parameters:

location - The location of the update site

categoryQualifier - The qualifier to prepend to categories. This qualifier is used to ensure that the category IDs are unique between update sites. If null a default qualifier will be generated

SiteXMLAction

public SiteXMLAction(UpdateSite updateSite,
                     java.lang.String categoryQualifier)

Creates a SiteXMLAction from an Update site with an optional qualifier to use for category names

Parameters:

updateSite - The update site

categoryQualifier - The qualifier to prepend to categories. This qualifier is used to ensure that the category IDs are unique between update sites. If null a default qualifier will be generated

Method Detail

setCategoryVersion

public void setCategoryVersion(java.lang.String version)

perform

public IStatus perform(IPublisherInfo publisherInfo,
                       IPublisherResult results,
                       IProgressMonitor monitor)

createVersionRange

protected VersionRange createVersionRange(java.lang.String versionId)

getFeatureToCategoryMappings

protected java.util.Map<SiteFeature,java.util.Set<SiteCategory>> getFeatureToCategoryMappings(IPublisherInfo publisherInfo)

Computes the mapping of features to categories as defined in the site.xml, if available. Returns an empty map if there is not site.xml, or no categories.

Returns:

A map of SiteFeature -> Set.

getBundleToCategoryMappings

protected java.util.Map<SiteBundle,java.util.Set<SiteCategory>> getBundleToCategoryMappings(IPublisherInfo publisherInfo)

Computes the mapping of bundles to categories as defined in the site.xml, if available. Returns an empty map if there is not site.xml, or no categories.

Returns:

A map of SiteBundle -> Set.

generateCategoryIUs

protected void generateCategoryIUs(java.util.Map<SiteCategory,java.util.Set<IInstallableUnit>> categoriesToIUs,
                                   IPublisherResult result)

Generates IUs corresponding to update site categories.

Parameters:

categoriesToIUs - Map of SiteCategory ->Set (Feature IUs in that category).

result - The generator result being built

createCategoryIU

@Deprecated
public IInstallableUnit createCategoryIU(SiteCategory category,
                                                     java.util.Set<IInstallableUnit> childrenIUs,
                                                     IInstallableUnit nestedCategory)

Deprecated. use IInstallableUnitcreateCategoryIU(SiteCategory, Set) instead

Creates an IU corresponding to an update site category

Parameters:

category - The category descriptor

childrenIUs - The IUs of the children that belong to the category (can be bundle, feature or nested categories)

nestedCategory - A nested category (optional)

Returns:

an IU representing the category

createCategoryIU

public IInstallableUnit createCategoryIU(SiteCategory category,
                                         java.util.Set<IInstallableUnit> childrenIUs)

Creates an IU corresponding to an update site category

Parameters:

category - The category descriptor

childrenIUs - The IUs of the children that belong to the category (can be bundle, feature or nested categories)

Returns:

an IU representing the category

getTransport

protected Transport getTransport(IPublisherInfo info)