org.docgene.model

Class ArticleRef

java.lang.Object

org.docgene.model.ArticleRef

All Implemented Interfaces:

java.lang.Comparable<ArticleRef>

public class ArticleRef
extends java.lang.Object
implements java.lang.Comparable<ArticleRef>

Represent the reference of an article.

Constructor Summary

Constructors

Constructor and Description
ArticleRef(org.docgene.model.Article article) Constructor.
ArticleRef(java.lang.String id) Constructor.
ArticleRef(java.lang.String id, java.lang.String pack) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ArticleRef other)
boolean	equals(java.lang.Object obj)
java.lang.String	getID() Return the article id.
java.lang.String	getPackage() Return the article package.
int	hashCode()
boolean	hasPackage() Return true if the article belongs to a package
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ArticleRef

public ArticleRef(org.docgene.model.Article article)

Constructor.

Parameters:

article - the article

ArticleRef

public ArticleRef(java.lang.String id)

Constructor.

Parameters:

id - the article ID

ArticleRef

public ArticleRef(java.lang.String id,
                  java.lang.String pack)

Constructor.

Parameters:

id - the article ID

pack - the article package

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(ArticleRef other)

Specified by:

compareTo in interface java.lang.Comparable<ArticleRef>

getID

public java.lang.String getID()

Return the article id.

Returns:

the article id

hasPackage

public boolean hasPackage()

Return true if the article belongs to a package

Returns:

true if the article belongs to a package

getPackage

public java.lang.String getPackage()

Return the article package.

Returns:

the article package