weka.core.TechnicalInformation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of weka-dev Show documentation
Show all versions of weka-dev Show documentation
The Waikato Environment for Knowledge Analysis (WEKA), a machine
learning workbench. This version represents the developer version, the
"bleeding edge" of development, you could say. New functionality gets added
to this version.
/*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see m_Values = new Hashtable();
/** additional technical informations */
protected Vector m_Additional = new Vector();
/**
* Initializes the information with the given type
*
* @param type the type of this information
* @see Type
*/
public TechnicalInformation(Type type) {
this(type, "");
}
/**
* Initializes the information with the given type
*
* @param type the type of this information
* @param id the unique ID (for BibTex), can be empty
* @see Type
*/
public TechnicalInformation(Type type, String id) {
m_Type = type;
m_ID = id;
}
/**
* returns the type of this technical information
*
* @return the type of this information
*/
public Type getType() {
return m_Type;
}
/**
* splits the authors on the " and " and returns a vector with the names
*
* @return the authors in an array
*/
protected String[] getAuthors() {
return getValue(Field.AUTHOR).split(" and ");
}
/**
* Generates an ID based on the current settings and returns it. If nothing
* can be generated the MISSING_ID string will be returned
*
* @return the ID
* @see #MISSING_ID
*/
protected String generateID() {
String result;
String[] authors;
String[] parts;
result = m_ID;
// try surname of first author and year
if (result.length() == 0) {
if (exists(Field.AUTHOR) && exists(Field.YEAR)) {
authors = getAuthors();
if (authors[0].indexOf(",") > -1) {
parts = authors[0].split(",");
result = parts[0];
} else {
parts = authors[0].split(" ");
if (parts.length == 1) {
result = parts[0];
} else {
result = parts[parts.length - 1];
}
}
result += getValue(Field.YEAR);
result = result.replaceAll(" ", "");
}
}
// still nothing?
if (result.length() == 0) {
result = MISSING_ID;
}
return result;
}
/**
* returns the unique ID (either the one used in creating this instance or the
* automatically generated one)
*
* @return the ID for this information
*/
public String getID() {
return generateID();
}
/**
* sets the value for the given field, overwrites any previously existing one.
*
* @param field the field to set the value for
* @param value the value of the field
*/
public void setValue(Field field, String value) {
m_Values.put(field, value);
}
/**
* returns the value associated with the given field, or empty if field is not
* currently stored.
*
* @param field the field to retrieve the value for
* @return the value associated with this field, empty if not existing
*/
public String getValue(Field field) {
if (m_Values.containsKey(field)) {
return m_Values.get(field);
} else {
return "";
}
}
/**
* returns TRUE if the field is stored and has a value different from the
* empty string.
*
* @param field the field to check
* @return true if a value is stored for the field and non-empty
*/
public boolean exists(Field field) {
return (m_Values.containsKey(field) && (m_Values.get(field).length() != 0));
}
/**
* returns an enumeration over all the stored fields
*
* @return all currently stored fields
*/
public Enumeration fields() {
return m_Values.keys();
}
/**
* returns true if there are further technical informations stored in this
*
* @return true if there are further technical informations available
*/
public boolean hasAdditional() {
return (m_Additional.size() > 0);
}
/**
* returns an enumeration of all the additional technical informations (if
* there are any)
*
* @return an enumeration over all additional technical informations
*/
public Enumeration additional() {
return m_Additional.elements();
}
/**
* adds the given information to the list of additional technical informations
*
* @param value the information to add
*/
public void add(TechnicalInformation value) {
if (value == this) {
throw new IllegalArgumentException("Can't add object to itself!");
}
m_Additional.add(value);
}
/**
* Adds an empty technical information with the given type to the list of
* additional informations and returns the instance.
*
* @param type the type of the new information to add
* @return the generated information
*/
public TechnicalInformation add(Type type) {
TechnicalInformation result;
result = new TechnicalInformation(type);
add(result);
return result;
}
/**
* Returns a plain-text string representing this technical information. Note:
* it only returns a string based on some fields. At least AUTHOR, YEAR and
* TITLE are necessary.
*
* @return a string representation of this information
*/
@Override
public String toString() {
String result;
String[] authors;
int i;
Enumeration enm;
result = "";
authors = getAuthors();
// BOOK
if (getType() == Type.BOOK) {
for (i = 0; i < authors.length; i++) {
if (i > 0) {
result += ", ";
}
result += authors[i];
}
if (exists(Field.YEAR)) {
result += " (" + getValue(Field.YEAR) + ").";
} else {
result += ".";
}
result += " " + getValue(Field.TITLE) + ".";
result += " " + getValue(Field.PUBLISHER);
if (exists(Field.ADDRESS)) {
result += ", " + getValue(Field.ADDRESS);
}
result += ".";
}
// ARTICLE
else if (getType() == Type.ARTICLE) {
for (i = 0; i < authors.length; i++) {
if (i > 0) {
result += ", ";
}
result += authors[i];
}
if (exists(Field.YEAR)) {
result += " (" + getValue(Field.YEAR) + ").";
} else {
result += ".";
}
result += " " + getValue(Field.TITLE) + ".";
// journal
if (exists(Field.JOURNAL)) {
result += " " + getValue(Field.JOURNAL) + ".";
if (exists(Field.VOLUME)) {
result += " " + getValue(Field.VOLUME);
}
if (exists(Field.NUMBER)) {
result += "(" + getValue(Field.NUMBER) + ")";
}
if (exists(Field.PAGES)) {
result += ":" + getValue(Field.PAGES);
}
result += ".";
}
// other than JOURNAL???
// URL
if (exists(Field.URL)) {
result += " URL " + getValue(Field.URL) + ".";
}
}
// CONFERENCE/INPROCEEDINGS
else if ((getType() == Type.CONFERENCE)
|| (getType() == Type.INPROCEEDINGS)) {
for (i = 0; i < authors.length; i++) {
if (i > 0) {
result += ", ";
}
result += authors[i];
}
result += ": " + getValue(Field.TITLE) + ".";
result += " In: " + getValue(Field.BOOKTITLE);
if (exists(Field.ADDRESS)) {
result += ", " + getValue(Field.ADDRESS);
}
if (exists(Field.PAGES)) {
result += ", " + getValue(Field.PAGES);
}
if (exists(Field.YEAR)) {
result += ", " + getValue(Field.YEAR) + ".";
} else {
result += ".";
}
}
// INCOLLECTION
else if (getType() == Type.INCOLLECTION) {
for (i = 0; i < authors.length; i++) {
if (i > 0) {
result += ", ";
}
result += authors[i];
}
result += ": " + getValue(Field.TITLE) + ".";
result += " In ";
if (exists(Field.EDITOR)) {
result += getValue(Field.EDITOR) + ", editors, ";
}
result += getValue(Field.BOOKTITLE);
if (exists(Field.ADDRESS)) {
result += ", " + getValue(Field.ADDRESS);
}
if (exists(Field.PAGES)) {
result += ", " + getValue(Field.PAGES);
}
if (exists(Field.YEAR)) {
result += ", " + getValue(Field.YEAR) + ".";
} else {
result += ".";
}
}
// default
else {
for (i = 0; i < authors.length; i++) {
if (i > 0) {
result += ", ";
}
result += authors[i];
}
if (exists(Field.YEAR)) {
result += " (" + getValue(Field.YEAR) + ").";
} else {
result += ".";
}
result += " " + getValue(Field.TITLE) + ".";
if (exists(Field.ADDRESS)) {
result += " " + getValue(Field.ADDRESS) + ".";
}
if (exists(Field.URL)) {
result += " URL " + getValue(Field.URL) + ".";
}
}
// additional informations?
enm = additional();
while (enm.hasMoreElements()) {
result += "\n\n" + enm.nextElement().toString();
}
return result;
}
/**
* Returns a BibTex string representing this technical information. Note: this
* is just a very raw implementation, special characters need to be escaped
* manually for LaTeX.
*
* @return the BibTeX representation of this information
*/
public String toBibTex() {
String result;
Field field;
Vector list;
int i;
String value;
result = "@" + getType() + "{" + getID() + "";
// sort the fields
list = new Vector();
Enumeration enm = fields();
while (enm.hasMoreElements()) {
list.add(enm.nextElement());
}
Collections.sort(list);
// list field=value pairs
for (i = 0; i < list.size(); i++) {
field = list.get(i);
if (!exists(field)) {
continue;
}
value = getValue(field);
value = value.replaceAll("\\~", "\\\\~");
result += ",\n " + field + " = {" + value + "}";
}
result += "\n}";
// additional informations?
Enumeration enm2 = additional();
while (enm2.hasMoreElements()) {
result += "\n\n" + enm2.nextElement().toBibTex();
}
return result;
}
/**
* Returns the revision string.
*
* @return the revision
*/
@Override
public String getRevision() {
return RevisionUtils.extract("$Revision: 10203 $");
}
/**
* Prints some examples of technical informations if there are no commandline
* options given. Otherwise the information of a given
* TechnicalInformationHandler can be printed.
*
*
* Valid options are:
*
*
* -W classname
* The classname of the TechnicalInformationHandler to print the information
* for
*
*
* -bibtex
* Print the information in BibTeX format
*
*
* -plaintext
* Print the information in plain text format
*
*
* @param args the commandline options
* @throws Exception if the option parsing fails
*/
public static void main(String[] args) throws Exception {
TechnicalInformation info;
TechnicalInformation additional;
String tmpStr;
Class cls;
TechnicalInformationHandler handler;
// example from command line
if (args.length != 0) {
info = null;
tmpStr = Utils.getOption('W', args);
if (tmpStr.length() != 0) {
cls = Class.forName(tmpStr);
handler = (TechnicalInformationHandler) cls.newInstance();
info = handler.getTechnicalInformation();
} else {
throw new IllegalArgumentException(
"A classname has to be provided with the -W option!");
}
if (Utils.getFlag("bibtex", args)) {
System.out.println("\n" + handler.getClass().getName() + ":\n"
+ info.toBibTex());
}
if (Utils.getFlag("plaintext", args)) {
System.out.println("\n" + handler.getClass().getName() + ":\n"
+ info.toString());
}
} else {
// first example
info = new TechnicalInformation(Type.BOOK);
info.setValue(Field.AUTHOR, "Ross Quinlan");
info.setValue(Field.YEAR, "1993");
info.setValue(Field.TITLE, "C4.5: Programs for Machine Learning");
info.setValue(Field.PUBLISHER, "Morgan Kaufmann Publishers");
info.setValue(Field.ADDRESS, "San Mateo, CA");
additional = info;
System.out.println("\ntoString():\n" + info.toString());
System.out.println("\ntoBibTex():\n" + info.toBibTex());
// second example
info = new TechnicalInformation(Type.INPROCEEDINGS);
info.setValue(Field.AUTHOR, "Freund, Y. and Mason, L.");
info.setValue(Field.YEAR, "1999");
info.setValue(Field.TITLE,
"The alternating decision tree learning algorithm");
info
.setValue(Field.BOOKTITLE,
"Proceeding of the Sixteenth International Conference on Machine Learning");
info.setValue(Field.ADDRESS, "Bled, Slovenia");
info.setValue(Field.PAGES, "124-133");
System.out.println("\ntoString():\n" + info.toString());
System.out.println("\ntoBibTex():\n" + info.toBibTex());
// third example
info = new TechnicalInformation(Type.ARTICLE);
info.setValue(Field.AUTHOR, "R. Quinlan");
info.setValue(Field.YEAR, "1986");
info.setValue(Field.TITLE, "Induction of decision trees");
info.setValue(Field.JOURNAL, "Machine Learning");
info.setValue(Field.VOLUME, "1");
info.setValue(Field.NUMBER, "1");
info.setValue(Field.PAGES, "81-106");
additional = new TechnicalInformation(Type.BOOK);
additional.setValue(Field.AUTHOR, "Ross Quinlan");
additional.setValue(Field.YEAR, "1993");
additional.setValue(Field.TITLE, "C4.5: Programs for Machine Learning");
additional.setValue(Field.PUBLISHER, "Morgan Kaufmann Publishers");
additional.setValue(Field.ADDRESS, "San Mateo, CA");
info.add(additional);
System.out.println("\ntoString():\n" + info.toString());
System.out.println("\ntoBibTex():\n" + info.toBibTex());
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy