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

Class MetaDescription

java.lang.Object

de.julielab.jcore.pipeline.builder.base.main.MetaDescription

All Implemented Interfaces:

IMetaDescription, Serializable

public class MetaDescription
extends Object
implements IMetaDescription, Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	MetaDescription.FromJsonSetup

Constructor Summary

Constructors

Constructor	Description
MetaDescription()

Method Summary

Modifier and Type	Method	Description
String	getBase()	The name of the base component.
String	getBaseProject()
List<PipelineBuilderConstants.JcoreMeta.Category>	getCategories()
Description	getChosenDescriptor()
Integer	getChosenDescriptorAsIndex()
String	getDescription()
String	getGroup()
Description	getJCoReDescription(String specifier)	Returns a specific descriptor object.
Collection<Description>	getJCoReDescriptions()	Returns a collection of all the descriptor names for this component.
de.julielab.utilities.aether.MavenArtifact	getMavenArtifact()
de.julielab.utilities.aether.MavenArtifact	getMavenArtifactCoordinates()	This method returns the MavenArtifact of this MetaDescription as-is, i.e.
ComponentRepository	getModule()
String	getName()	Returns the visible name of this component.
boolean	isExposable()
Boolean	isPear()
void	setArtifact(de.julielab.utilities.aether.MavenArtifact artifact)
void	setBase(String base)
void	setBaseProject(String baseProject)
void	setChosenDescriptor(String xmlName)
void	setChosenDescriptorAsIndex(Integer descIndex)	Sets the chosen Descriptor as index reference to the Descriptor Array List
void	setDescription(String description)
void	setExposable(boolean exposable)
void	setGroup(String group)
void	setModule(ComponentRepository module)
void	setName(String name)
void	setPear(Boolean pear)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaDescription

public MetaDescription()

Method Detail

isPear

public Boolean isPear()

setPear

public void setPear(Boolean pear)

getBaseProject

public String getBaseProject()

setBaseProject

public void setBaseProject(String baseProject)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getBase

public String getBase()

The name of the base component. May be null if this is a base component.

Returns:

setBase

public void setBase(String base)

getGroup

public String getGroup()

setGroup

public void setGroup(String group)

isExposable

public boolean isExposable()

setExposable

public void setExposable(boolean exposable)

getChosenDescriptor

public Description getChosenDescriptor()
                                throws DescriptorLoadingException

Specified by:

getChosenDescriptor in interface IMetaDescription

Throws:

DescriptorLoadingException

setChosenDescriptor

public void setChosenDescriptor(String xmlName)
                         throws DescriptorLoadingException

Specified by:

setChosenDescriptor in interface IMetaDescription

Throws:

DescriptorLoadingException

getChosenDescriptorAsIndex

public Integer getChosenDescriptorAsIndex()

Specified by:

getChosenDescriptorAsIndex in interface IMetaDescription

setChosenDescriptorAsIndex

public void setChosenDescriptorAsIndex(Integer descIndex)

Description copied from interface: IMetaDescription

Sets the chosen Descriptor as index reference to the Descriptor Array List

Specified by:

setChosenDescriptorAsIndex in interface IMetaDescription

getJCoReDescription

public Description getJCoReDescription(String specifier)
                                throws DescriptorLoadingException

Description copied from interface: IMetaDescription

Returns a specific descriptor object.

Specified by:

getJCoReDescription in interface IMetaDescription

Returns:

Throws:

DescriptorLoadingException

getJCoReDescriptions

public Collection<Description> getJCoReDescriptions()
                                             throws DescriptorLoadingException

Description copied from interface: IMetaDescription

Returns a collection of all the descriptor names for this component. The names can be used to access a specific descriptor object via the getJCoReDescription method.

Specified by:

getJCoReDescriptions in interface IMetaDescription

Returns:

Throws:

DescriptorLoadingException

getName

public String getName()

Description copied from interface: IMetaDescription

Returns the visible name of this component.

Specified by:

getName in interface IMetaDescription

Returns:

setName

public void setName(String name)

getCategories

public List<PipelineBuilderConstants.JcoreMeta.Category> getCategories()

Specified by:

getCategories in interface IMetaDescription

toString

public String toString()

Overrides:

toString in class Object

setArtifact

public void setArtifact(de.julielab.utilities.aether.MavenArtifact artifact)

getMavenArtifact

public de.julielab.utilities.aether.MavenArtifact getMavenArtifact()

Specified by:

getMavenArtifact in interface IMetaDescription

getMavenArtifactCoordinates

public de.julielab.utilities.aether.MavenArtifact getMavenArtifactCoordinates()

This method returns the MavenArtifact of this MetaDescription as-is, i.e. the actual file location is not resolved. The returned value might still contain this information if the artifact has been initialized before through a call to getMavenArtifact().

Returns:

The maven artifact information of this MetaDescription, possibly without the file location information.

getModule

public ComponentRepository getModule()

setModule

public void setModule(ComponentRepository module)