org.hkijena.jipipe.api.artifacts

Class JIPipeArtifact

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.artifacts.JIPipeArtifact

All Implemented Interfaces:

Comparable<JIPipeArtifact>, JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener, JIPipeValidatable

Direct Known Subclasses:

JIPipeLocalArtifact, JIPipeRemoteArtifact

public class JIPipeArtifact
extends AbstractJIPipeParameterCollection
implements Comparable<JIPipeArtifact>, JIPipeValidatable

Nested Class Summary

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterChangedEventEmitter, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEventEmitter, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEvent, JIPipeParameterCollection.ParameterUIChangedEventEmitter, JIPipeParameterCollection.ParameterUIChangedEventListener

Constructor Summary

Constructors

Constructor and Description
JIPipeArtifact()
JIPipeArtifact(JIPipeArtifact other)
JIPipeArtifact(String fullArtifactId)

Method Summary

Modifier and Type	Method and Description
int	compareTo(@NotNull JIPipeArtifact o)
String	getArtifactId()
String	getClassifier()
Path	getDefaultInstallationPath(Path localRepositoryPath)
String	getFullId() Returns a string GroupId.ArtifactId:Version-Classifier
int	getGPUVersion(String prefix)
String	getGroupId()
String	getVersion()
int	getVersionRevision()
String	getVersionWithoutRevision()
boolean	isCompatible() Returns true if this artifact is compatible with the current system Includes non-native compatibility (e.g., x86 is compatible to amd64)
boolean	isGPUCompatible(JIPipeArtifactAccelerationPreference accelerationPreference, Vector2iParameter accelerationPreferenceVersions)
boolean	isNative() Returns true if the artifact is perfectly compatible with the current system (excludes translation layers like x86 to amd64)
boolean	isRequireGPU()
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	setArtifactId(String artifactId)
void	setClassifier(String classifier)
void	setFullId(String fullId)
void	setGroupId(String groupId)
void	setVersion(String version)
String	toString()

Methods inherited from class org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, registerSubParameter, registerSubParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.validation.JIPipeValidatable

generateValidityReport

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, installUIOverrideParameterEditor, installUIParameterOptions, isParameterUIVisible, isParameterUIVisible, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Constructor Detail

JIPipeArtifact

public JIPipeArtifact()

JIPipeArtifact

public JIPipeArtifact(JIPipeArtifact other)

JIPipeArtifact

public JIPipeArtifact(String fullArtifactId)

Method Detail

getGroupId

public String getGroupId()

setGroupId

public void setGroupId(String groupId)

getArtifactId

public String getArtifactId()

setArtifactId

public void setArtifactId(String artifactId)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getClassifier

public String getClassifier()

setClassifier

public void setClassifier(String classifier)

getFullId

public String getFullId()

Returns a string GroupId.ArtifactId:Version-Classifier

Returns:

the full identifier string for this artifact

setFullId

public void setFullId(String fullId)

isCompatible

public boolean isCompatible()

Returns true if this artifact is compatible with the current system Includes non-native compatibility (e.g., x86 is compatible to amd64)

Returns:

if the artifact is compatible

isNative

public boolean isNative()

Returns true if the artifact is perfectly compatible with the current system (excludes translation layers like x86 to amd64)

Returns:

if the artifact is perfectly compatible

isRequireGPU

public boolean isRequireGPU()

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(@NotNull
                     @NotNull JIPipeArtifact o)

Specified by:

compareTo in interface Comparable<JIPipeArtifact>

getDefaultInstallationPath

public Path getDefaultInstallationPath(Path localRepositoryPath)

getGPUVersion

public int getGPUVersion(String prefix)

isGPUCompatible

public boolean isGPUCompatible(JIPipeArtifactAccelerationPreference accelerationPreference,
                               Vector2iParameter accelerationPreferenceVersions)

reportValidity

public void reportValidity(JIPipeValidationReportContext reportContext,
                           JIPipeValidationReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Parameters:

reportContext - the report context

report - the report to be added to

getVersionWithoutRevision

public String getVersionWithoutRevision()

getVersionRevision

public int getVersionRevision()