Package de.julielab.jcore.pipeline.builder.base.interfaces

Interface IComponentMetaInformationService

All Known Implementing Classes:

ComponentMetaInformationService

public interface IComponentMetaInformationService

Method Summary

Modifier and Type	Method	Description
void	completeReload()
List<de.julielab.utilities.aether.MavenArtifact>	downloadArtifacts(List<de.julielab.utilities.aether.MavenArtifact> artifactIds)	Builds a map of "artifact name" - "artifact file" representations
Set<de.julielab.utilities.aether.MavenArtifact>	getArtifacts()
List<String>	getCategory(String componentName)
String[]	getDescriptors(String componentName)
String	getGroups(String componentName)
Collection<MetaDescription>	getMetaInformation()	Lists all exposed components of the module this ComponentMetaInformation object belongs to/ was created from.
Collection<MetaDescription>	getMetaInformation(ComponentRepository repository)
Collection<MetaDescription>	getMetaInformation(Boolean loadNew)	Lists all exposed components of the module this ComponentMetaInformation object belongs to/ was created from.
MetaDescription	getMetaInformation(String componentName)	Gets the meta information of a specific component.
MetaDescription	getMetaInformation(String componentName, Boolean loadNew)	Gets the meta information of a specific component.
Collection<MetaDescription>	getMetaInformationWithArtifacts(Boolean loadNew)	Lists all exposed components with their Maven artifacts already set.
String	getName(String componentName)
Set<de.julielab.utilities.aether.MavenArtifact>	loadAllArtifacts()
void	loadComponentMetaInformation(Boolean loadNew)	Builds a list of JsonObjects with their respective meta information.
void	loadMetaInformationFromDisk(ComponentRepository repository)

Method Detail

loadMetaInformationFromDisk

void loadMetaInformationFromDisk(ComponentRepository repository)
                          throws IOException,
                                 GithubInformationException

Throws:

IOException

GithubInformationException

loadComponentMetaInformation

void loadComponentMetaInformation(Boolean loadNew)
                           throws GithubInformationException

Builds a list of JsonObjects with their respective meta information.

Throws:

GithubInformationException

downloadArtifacts

List<de.julielab.utilities.aether.MavenArtifact> downloadArtifacts(List<de.julielab.utilities.aether.MavenArtifact> artifactIds)
                                                            throws GithubInformationException,
                                                                   de.julielab.utilities.aether.MavenException

Builds a map of "artifact name" - "artifact file" representations

Parameters:

artifactIds - a list of all the artifacts (their Maven ID) that should be downloaded.

Throws:

GithubInformationException

de.julielab.utilities.aether.MavenException

loadAllArtifacts

Set<de.julielab.utilities.aether.MavenArtifact> loadAllArtifacts()
                                                          throws GithubInformationException,
                                                                 DescriptorLoadingException,
                                                                 de.julielab.utilities.aether.MavenException

Returns:

Throws:

GithubInformationException

DescriptorLoadingException

de.julielab.utilities.aether.MavenException

getArtifacts

Set<de.julielab.utilities.aether.MavenArtifact> getArtifacts()
                                                      throws GithubInformationException

Throws:

GithubInformationException

getMetaInformation

Collection<MetaDescription> getMetaInformation(ComponentRepository repository)
                                        throws GithubInformationException

Throws:

GithubInformationException

getMetaInformation

Collection<MetaDescription> getMetaInformation()
                                        throws GithubInformationException

Lists all exposed components of the module this ComponentMetaInformation object belongs to/ was created from.

Returns:

Throws:

GithubInformationException

getMetaInformationWithArtifacts

Collection<MetaDescription> getMetaInformationWithArtifacts(Boolean loadNew)
                                                     throws GithubInformationException,
                                                            DescriptorLoadingException,
                                                            de.julielab.utilities.aether.MavenException

Lists all exposed components with their Maven artifacts already set. Meta descriptions whose artifacts cannot be found are filtered out.

Returns:

Throws:

GithubInformationException

DescriptorLoadingException

de.julielab.utilities.aether.MavenException

getMetaInformation

Collection<MetaDescription> getMetaInformation(Boolean loadNew)
                                        throws GithubInformationException

Lists all exposed components of the module this ComponentMetaInformation object belongs to/ was created from.

Parameters:

loadNew -

Returns:

Throws:

GithubInformationException

getMetaInformation

MetaDescription getMetaInformation(String componentName)
                            throws GithubInformationException

Gets the meta information of a specific component.

Parameters:

componentName -

Returns:

Throws:

GithubInformationException

getMetaInformation

MetaDescription getMetaInformation(String componentName,
                                   Boolean loadNew)
                            throws GithubInformationException

Gets the meta information of a specific component.

Parameters:

componentName -

loadNew -

Returns:

Throws:

GithubInformationException

getDescriptors

String[] getDescriptors(String componentName)
                 throws GithubInformationException,
                        DescriptorLoadingException

Throws:

GithubInformationException

DescriptorLoadingException

getName

String getName(String componentName)
        throws GithubInformationException

Throws:

GithubInformationException

getCategory

List<String> getCategory(String componentName)
                  throws GithubInformationException

Throws:

GithubInformationException

getGroups

String getGroups(String componentName)
          throws GithubInformationException

Throws:

GithubInformationException

completeReload

void completeReload()
             throws GithubInformationException,
                    DescriptorLoadingException,
                    de.julielab.utilities.aether.MavenException

Throws:

GithubInformationException

DescriptorLoadingException

de.julielab.utilities.aether.MavenException