|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcds.simbad.Reference
Field Summary | |
private java.util.ArrayList |
authors
|
private Bibcode |
bibcode
|
static java.lang.String |
COM_ABBR
|
static int |
COM_DIC
|
static int |
COM_ERR
|
static int |
COM_FILES
|
static int |
COM_FLAGS
|
static int |
COM_MAX
|
static java.lang.String[] |
COM_NAME
|
static int |
COM_NOTES
|
private java.lang.String |
journal
|
private int |
lastPage
|
private java.lang.String |
privateComment
|
private java.lang.String[] |
publicComments
|
private java.lang.String |
title
|
private int |
volume
|
private java.lang.String |
year
|
Constructor Summary | |
Reference()
Empty constructor. |
|
Reference(Bibcode bibcode)
Constructor initialized with a Bibcode object |
|
Reference(java.lang.String bibcode)
Constructor initializing a Reference object with a bibcode |
|
Reference(java.lang.String bibcode,
boolean normalize)
Constructor initializing a Reference object with a bibcode |
Method Summary | |
java.lang.Object |
clone()
Creates an initialize the Reference from a Parfile file be read from the 1st encountered empty line (separator) to the next one, leaving the file ready for further reads. |
int |
compareTo(java.lang.Object object)
MOD-BB 29/10/03 Comparaison de References. |
boolean |
fromParfile(java.io.BufferedReader rdr)
Initialize the reference from a Parfile. |
java.util.ArrayList |
getAuthors()
Get the author list |
Bibcode |
getBibcode()
Gets the bibcode object. |
java.lang.String |
getJournal()
Get the journal |
int |
getLastPage()
Get last page number |
java.lang.String |
getPrivateComment()
Get the private comment |
java.lang.String |
getPublicComment(int type)
Get a public comment |
java.lang.String[] |
getPublicComments()
Get the array of public comments |
java.lang.String |
getTitle()
Get the title |
int |
getVolume()
Get the volume |
java.lang.String |
getYear()
Get the year |
static java.lang.String |
joinAuthors(java.util.ArrayList alist)
Build the full string of authors from the arrayList |
static java.lang.String |
joinAuthors(java.util.ArrayList alist,
boolean and)
Build the full string of authors from the arrayList |
static java.lang.String |
joinPublicComments(java.lang.String[] publicComments)
Join an array of public comments into one string following the syntax described for splitPublicComments |
void |
reset()
Reinitialize a Reference object (for reuse purpose) |
void |
setAuthor(java.lang.String author)
Sets an author. |
void |
setAuthors(java.util.ArrayList authors_list)
MOD-BB 20/10/03 Ajout de cette méthode. |
void |
setAuthors(java.lang.String[] authorlist)
Sets an author list. |
void |
setBibcode(Bibcode bibcode)
Sets the bibcode |
void |
setBibcode(java.lang.String bibcode)
Sets the bibcode |
void |
setBibcode(java.lang.String bibcode,
boolean normalize)
Sets the bibcode |
void |
setJournal(java.lang.String journal)
Set the journal |
void |
setLastPage(int lastpage)
Set last page number |
void |
setLastPage(java.lang.String lastpage)
Set last page number |
void |
setPrivateComment(java.lang.String comment)
Set the private comment |
void |
setPublicComment(char type,
java.lang.String comment)
Set a public comment. |
void |
setPublicComment(int type,
java.lang.String comment)
Set a public comment. |
void |
setPublicComments(java.lang.String[] public_comments)
MOD-BB 20/10/03 ajout de cette méthode. |
void |
setTitle(java.lang.String title)
Set the title |
void |
setVolume(int volume)
Set the volume |
void |
setYear(java.lang.String year)
Set the year |
static java.util.ArrayList |
splitAuthors(java.lang.String authlist)
Split a author list in its individual author names |
static java.lang.String[] |
splitPublicComments(java.lang.String publicComments)
Splits a public comment string having the described syntax in its individual comments array. |
java.lang.String |
toString()
Methode d'edition d'une reference |
void |
toXML(VOTable vot)
XML output for the astronomical object. |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String COM_ABBR
public static final java.lang.String[] COM_NAME
public static final int COM_ERR
public static final int COM_DIC
public static final int COM_FLAGS
public static final int COM_FILES
public static final int COM_NOTES
public static final int COM_MAX
private Bibcode bibcode
private java.lang.String title
private java.lang.String journal
private java.lang.String year
private int volume
private int lastPage
private java.util.ArrayList authors
private java.lang.String[] publicComments
private java.lang.String privateComment
Constructor Detail |
public Reference()
public Reference(java.lang.String bibcode) throws BibcodeException
bibcode
- the bibcode. The string will be forcelly normalized
BibcodeException
public Reference(java.lang.String bibcode, boolean normalize) throws BibcodeException
bibcode
- the bibcode. The string will only be normalized if the
normalize parameter is set to true.normalize
- true if the bibcode has to be normalized
BibcodeException
public Reference(Bibcode bibcode)
bibcode
- the bibcode objectMethod Detail |
public void reset()
public void setBibcode(java.lang.String bibcode) throws BibcodeException
bibcode
- string representing a bibcode.It doesn't need to be
normalized
BibcodeException
public void setBibcode(java.lang.String bibcode, boolean normalize) throws BibcodeException
bibcode
- string representing a bibcode.It doesn't need to be
normalizednormalize
- true if the bibcode should e normalized
BibcodeException
public void setBibcode(Bibcode bibcode)
bibcode
- Bibcode objectpublic Bibcode getBibcode()
public void setTitle(java.lang.String title)
title
- title textpublic java.lang.String getTitle()
public void setJournal(java.lang.String journal)
journal
- journal namepublic java.lang.String getJournal()
public void setYear(java.lang.String year)
year
- year to setpublic java.lang.String getYear()
public void setVolume(int volume)
volume
- publication volumepublic int getVolume()
public void setLastPage(java.lang.String lastpage)
lastpage
- last page numberpublic void setLastPage(int lastpage)
lastpage
- last page numberpublic int getLastPage()
public void setAuthor(java.lang.String author)
author
- author namepublic void setAuthors(java.lang.String[] authorlist)
authorlist
- list (possibly partial) author listpublic void setAuthors(java.util.ArrayList authors_list)
authors_list
- Un list d'auteurs.public java.util.ArrayList getAuthors()
public void setPublicComment(int type, java.lang.String comment)
type
- comment type. it can be either the code (preferably using
Reference.COM_ERR, Reference.COM_DIC, etc...) or the letter ('E','C',...)comment
- comment textpublic void setPublicComment(char type, java.lang.String comment)
type
- letter definition ('E','C', ...)comment
- comment textpublic java.lang.String getPublicComment(int type)
type
- comment type (can be either its code (i.e. Reference.COM_FILES),
or the letter (i.e. 'c')
public java.lang.String[] getPublicComments()
public void setPublicComments(java.lang.String[] public_comments)
public_comments
- Commentaires public.public void setPrivateComment(java.lang.String comment)
comment
- private commentpublic java.lang.String getPrivateComment()
public boolean fromParfile(java.io.BufferedReader rdr)
rdr
- input file
public static java.lang.String[] splitPublicComments(java.lang.String publicComments)
publicComments
- string containing all public comments
public static java.lang.String joinPublicComments(java.lang.String[] publicComments)
publicComments
- the array of public comments
public static java.util.ArrayList splitAuthors(java.lang.String authlist)
authlist
- list of authors. The names must be separated by a comma.
The two last authors may be separated by ' and '.
public static java.lang.String joinAuthors(java.util.ArrayList alist)
alist
- ArrayList of author names
public static java.lang.String joinAuthors(java.util.ArrayList alist, boolean and)
alist
- ArrayList of author namesand
- true if the 'and' operator should be applied between the two
las authors of the list
public java.lang.Object clone()
public void toXML(VOTable vot)
toXML
in interface SimbadObject
vot
- VOTable object driving the output.public java.lang.String toString()
toString
in interface SimbadObject
public int compareTo(java.lang.Object object)
compareTo
in interface java.lang.Comparable
object
- Référence que l'on veut comparer.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |