net.ossindex.common.resource

Class ArtifactResource

java.lang.Object

net.ossindex.common.resource.AbstractRemoteResource

net.ossindex.common.resource.ArtifactResource

All Implemented Interfaces:

Comparable<ArtifactResource>

public class ArtifactResource
extends AbstractRemoteResource
implements Comparable<ArtifactResource>

Representation of the FileResource, backed by the OSS Index REST API

Author:

Ken Duck

Constructor Summary

Constructors

Constructor and Description
ArtifactResource(long id) Create a new artifact

Method Summary

Modifier and Type	Method and Description
int	compareTo(ArtifactResource res)
ArtifactResource[]	getDependencyGraph() Get the dependency graph for the artifact
String	getDescription() Get the artifact description
String	getName() Get the name of the resource
PackageResource	getPackage() Get the package the artifact belongs to
String	getPackageManager() Get the name of the package manager that owns the artifact
String	getPackageName() Get the package name
protected String	getResourceType() Get the OSS Index resource type.
long	getScmId() Get the ID of the SCM related to the artifact
String[]	getSearch() When the resource is retrieved in a search, this returns the search strings that were used.
net.ossindex.version.IVersion	getVersion() Get the semantic version for the resource.
String	getVersionString() Get the version string

Methods inherited from class net.ossindex.common.resource.AbstractRemoteResource

exists, getId

Methods inherited from class java.lang.Object

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

Constructor Detail

ArtifactResource

public ArtifactResource(long id)

Create a new artifact

Parameters:

id - The ID of the artifact in OSS Index

Method Detail

getResourceType

protected String getResourceType()

Description copied from class: AbstractRemoteResource

Get the OSS Index resource type.

Specified by:

getResourceType in class AbstractRemoteResource

Returns:

The resource type name

getName

public String getName()

Get the name of the resource

Returns:

The name of the resource

getPackageName

public String getPackageName()

Get the package name

Returns:

The package name

getVersionString

public String getVersionString()

Get the version string

Returns:

A version string

getDescription

public String getDescription()

Get the artifact description

Returns:

A description

getPackageManager

public String getPackageManager()

Get the name of the package manager that owns the artifact

Returns:

The package manager name

getSearch

public String[] getSearch()

When the resource is retrieved in a search, this returns the search strings that were used.

Returns:

The search strings

getScmId

public long getScmId()

Get the ID of the SCM related to the artifact

Returns:

The SCM ID

getVersion

public net.ossindex.version.IVersion getVersion()

Get the semantic version for the resource.

Returns:

The artifact version

compareTo

public int compareTo(ArtifactResource res)

Specified by:

compareTo in interface Comparable<ArtifactResource>

getPackage

public PackageResource getPackage()
                           throws IOException

Get the package the artifact belongs to

Returns:

The package resource owning this resource

Throws:

IOException - On error

getDependencyGraph

public ArtifactResource[] getDependencyGraph()

Get the dependency graph for the artifact

Returns:

Dependency graph