|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.norvelle.textcite.model.Citation
public class Citation
Nested Class Summary | |
---|---|
static class |
Citation.CitationConverter
CitationConverter is an inner class used for serializing Citation objects via XStream. |
Field Summary | |
---|---|
static int |
AUTHOR_COLUMN
|
static int |
BOOK_COLUMN
|
static int |
CATEGORY_COLUMN
|
static int |
NUM_COLUMNS
|
static int |
PAGEREF_COLUMN
|
static int |
SUMMARY_COLUMN
|
Constructor Summary | |
---|---|
protected |
Citation()
A parameterless constructor, so that we can recreate a serialized Citation from XML. |
|
Citation(Book book)
The object constructor. |
|
Citation(Book book,
java.lang.String text,
java.lang.String summary,
java.lang.String pageRef)
The object constructor that also takes a text selection and a summary. |
Method Summary | |
---|---|
int |
compareTo(java.lang.Object otherCitation,
java.util.Vector comparators)
Performs a comparison between this Citation and another one, based on a comparison of all of the fields indicated by the current comparators vector. |
void |
destroy()
Unregister this Citation from all objects that reference it, and remove it from the master CitationCollection. |
void |
doUpgrade(double citebookVersion)
When loading a Citebook of an older version, we may need to update the Citation objects that it contains. |
Book |
getBook()
|
CitationCategoryCollection |
getCategories()
Returns the list of Category objects associated with this Citation. |
java.lang.Object |
getColumnValue(int colnum)
This method translates a numeric column number into a data field, and returns that field's value. |
java.lang.String |
getComment()
|
int |
getId()
|
BookOutlineItem |
getOutlineItem()
|
java.lang.String |
getPageReference()
|
java.lang.String |
getSummary()
|
java.lang.String |
getText()
|
java.lang.String |
getTranslation()
|
boolean |
hasCommentary()
|
boolean |
hasTranslation()
|
boolean |
isOrphan()
|
void |
registerCategory(Category cat)
Add a Category to those listed as being associated with this Citation |
void |
setBook(Book book)
The setter method for modifying the Book associated with this Citation. |
void |
setCategories(CitationCategoryCollection categoryList)
Set the list of categories associated with this Citation. |
void |
setComment(java.lang.String comment)
|
void |
setOutlineItem(BookOutlineItem outlineItem)
|
void |
setPageReference(java.lang.String pageReference)
|
void |
setSummary(java.lang.String summary)
|
void |
setText(java.lang.String citationText)
In order to make sure that the JTable gets updated correctly, we notify Listeners of the change to this Citation. |
void |
setTranslation(java.lang.String translation)
|
void |
unregisterCategory(Category cat)
Remove a given Category from those associated with this Citation. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int BOOK_COLUMN
public static final int AUTHOR_COLUMN
public static final int PAGEREF_COLUMN
public static final int SUMMARY_COLUMN
public static final int CATEGORY_COLUMN
public static final int NUM_COLUMNS
Constructor Detail |
---|
public Citation(Book book)
book
- The Book object that this Citation is associated with.public Citation(Book book, java.lang.String text, java.lang.String summary, java.lang.String pageRef)
book
- The Book object that this Citation is associated with.text
- The text to be stored in this object.summary
- The summary text (no more than a single sentence) that capsulizes what the citation is about.protected Citation()
Method Detail |
---|
public void destroy()
public void unregisterCategory(Category cat)
cat
- The Category to be removedpublic void registerCategory(Category cat)
cat
- The Category to add.public BookOutlineItem getOutlineItem()
public void setOutlineItem(BookOutlineItem outlineItem)
outlineItem
- The BookOutlineItem to associate with this Citation.public java.lang.String getSummary()
public void setSummary(java.lang.String summary)
public java.lang.String getComment()
public void setComment(java.lang.String comment)
public java.lang.String getTranslation()
public void setTranslation(java.lang.String translation)
public boolean hasTranslation()
public boolean hasCommentary()
public java.lang.Object getColumnValue(int colnum)
colnum
- The number of the column to be retrieved.
public void setText(java.lang.String citationText)
citationText
- The new text to be assigned.public java.lang.String getText()
public java.lang.String getPageReference()
public void setPageReference(java.lang.String pageReference)
public CitationCategoryCollection getCategories()
public void setCategories(CitationCategoryCollection categoryList)
categoryList
- The CitationCategoryCollection to be associated.public int getId()
public Book getBook()
public void setBook(Book book)
book
- public void doUpgrade(double citebookVersion)
citebookVersion
- public int compareTo(java.lang.Object otherCitation, java.util.Vector comparators) throws java.lang.ClassCastException
otherCitation
- The Citation object that this Citation will be compared withcomparators
- The Vector of Comparator object that will be used to provide a multi-field sort
java.lang.ClassCastException
- if the otherCitation parameter is not a Citationpublic boolean isOrphan()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |