Add javadoc

CWTSLeiden · Jan 22, 2024 · 1734162 · 1734162
1 parent 385fc20
commit 1734162
Show file tree

Hide file tree

Showing 25 changed files with 4,693 additions and 0 deletions.
diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html
@@ -0,0 +1,23 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http:https://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<title>All Classes (publicationclassificationlabeling 385fc20 API)</title>
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+</head>
+<body>
+<h1 class="bar">All&nbsp;Classes</h1>
+<div class="indexContainer">
+<ul>
+<li><a href="nl/cwts/publicationclassificationlabeling/ClusterLabeling.html" title="class in nl.cwts.publicationclassificationlabeling" target="classFrame">ClusterLabeling</a></li>
+<li><a href="nl/cwts/publicationclassificationlabeling/run/DatabaseIO.html" title="class in nl.cwts.publicationclassificationlabeling.run" target="classFrame">DatabaseIO</a></li>
+<li><a href="nl/cwts/publicationclassificationlabeling/run/FileIO.html" title="class in nl.cwts.publicationclassificationlabeling.run" target="classFrame">FileIO</a></li>
+<li><a href="nl/cwts/publicationclassificationlabeling/GPTClusterLabeler.html" title="class in nl.cwts.publicationclassificationlabeling" target="classFrame">GPTClusterLabeler</a></li>
+<li><a href="nl/cwts/publicationclassificationlabeling/GPTModel.html" title="enum in nl.cwts.publicationclassificationlabeling" target="classFrame">GPTModel</a></li>
+<li><a href="nl/cwts/publicationclassificationlabeling/run/PublicationClassificationLabelingCreator.html" title="class in nl.cwts.publicationclassificationlabeling.run" target="classFrame">PublicationClassificationLabelingCreator</a></li>
+</ul>
+</div>
+</body>
+</html>
diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html
@@ -0,0 +1,23 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http:https://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<title>All Classes (publicationclassificationlabeling 385fc20 API)</title>
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+</head>
+<body>
+<h1 class="bar">All&nbsp;Classes</h1>
+<div class="indexContainer">
+<ul>
+<li><a href="nl/cwts/publicationclassificationlabeling/ClusterLabeling.html" title="class in nl.cwts.publicationclassificationlabeling">ClusterLabeling</a></li>
+<li><a href="nl/cwts/publicationclassificationlabeling/run/DatabaseIO.html" title="class in nl.cwts.publicationclassificationlabeling.run">DatabaseIO</a></li>
+<li><a href="nl/cwts/publicationclassificationlabeling/run/FileIO.html" title="class in nl.cwts.publicationclassificationlabeling.run">FileIO</a></li>
+<li><a href="nl/cwts/publicationclassificationlabeling/GPTClusterLabeler.html" title="class in nl.cwts.publicationclassificationlabeling">GPTClusterLabeler</a></li>
+<li><a href="nl/cwts/publicationclassificationlabeling/GPTModel.html" title="enum in nl.cwts.publicationclassificationlabeling">GPTModel</a></li>
+<li><a href="nl/cwts/publicationclassificationlabeling/run/PublicationClassificationLabelingCreator.html" title="class in nl.cwts.publicationclassificationlabeling.run">PublicationClassificationLabelingCreator</a></li>
+</ul>
+</div>
+</body>
+</html>
diff --git a/docs/constant-values.html b/docs/constant-values.html
@@ -0,0 +1,176 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http:https://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<title>Constant Field Values (publicationclassificationlabeling 385fc20 API)</title>
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="Constant Field Values (publicationclassificationlabeling 385fc20 API)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="overview-summary.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
+<li><a href="constant-values.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h1 title="Constant Field Values" class="title">Constant Field Values</h1>
+<h2 title="Contents">Contents</h2>
+<ul>
+<li><a href="#nl.cwts">nl.cwts.*</a></li>
+</ul>
+</div>
+<div class="constantValuesContainer"><a name="nl.cwts">
+<!-- -->
+</a>
+<h2 title="nl.cwts">nl.cwts.*</h2>
+<ul class="blockList">
+<li class="blockList">
+<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
+<caption><span>nl.cwts.publicationclassificationlabeling.run.<a href="nl/cwts/publicationclassificationlabeling/run/FileIO.html" title="class in nl.cwts.publicationclassificationlabeling.run">FileIO</a></span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th scope="col">Constant Field</th>
+<th class="colLast" scope="col">Value</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a name="nl.cwts.publicationclassificationlabeling.run.FileIO.COLUMN_SEPARATOR">
+<!-- -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="nl/cwts/publicationclassificationlabeling/run/FileIO.html#COLUMN_SEPARATOR">COLUMN_SEPARATOR</a></code></td>
+<td class="colLast"><code>"\t"</code></td>
+</tr>
+</tbody>
+</table>
+</li>
+<li class="blockList">
+<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
+<caption><span>nl.cwts.publicationclassificationlabeling.run.<a href="nl/cwts/publicationclassificationlabeling/run/PublicationClassificationLabelingCreator.html" title="class in nl.cwts.publicationclassificationlabeling.run">PublicationClassificationLabelingCreator</a></span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th scope="col">Constant Field</th>
+<th class="colLast" scope="col">Value</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a name="nl.cwts.publicationclassificationlabeling.run.PublicationClassificationLabelingCreator.DESCRIPTION">
+<!-- -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="nl/cwts/publicationclassificationlabeling/run/PublicationClassificationLabelingCreator.html#DESCRIPTION">DESCRIPTION</a></code></td>
+<td class="colLast"><code>"PublicationClassificationLabelingCreator version 1.0.0\nBy Nees Jan van Eck\nCentre for Science and Technology Studies (CWTS), Leiden University\n"</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="nl.cwts.publicationclassificationlabeling.run.PublicationClassificationLabelingCreator.USAGE">
+<!-- -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="nl/cwts/publicationclassificationlabeling/run/PublicationClassificationLabelingCreator.html#USAGE">USAGE</a></code></td>
+<td class="colLast"><code>"Usage: PublicationClassificationLabelingCreator\n\t&lt;pub_titles_file&gt; &lt;label_file&gt;\n\t&lt;api_key&gt; &lt;gpt_model&gt; &lt;print_labeling&gt;\n\t\t(to create a publication classification labeling based on data in text files)\n\n or PublicationClassificationLabelingCreator\n\t&lt;server&gt; &lt;database&gt; &lt;pub_titles_table&gt; &lt;label_table&gt;\n\t&lt;api_key&gt; &lt;gpt_model&gt; &lt;print_labeling&gt;\n\t\t(to create a publication classification labeling based on data in an SQL Server database)\n\nArguments:\n&lt;pub_titles_file&gt;\n\tName of the publication titles input file. This text file must contain two tab-separated \n\tcolumns (without a header line): a column of cluster numbers and a column of publication \n\ttitles. The cluster numbers in the first column must be integers starting at zero. The \n\tpublication titles in the second column (e.g., the titles of a sample of 100 publications) \n\tmust be concatenated into a single string. The lines in the file must be sorted by the \n\tcluster numbers in the first column.\n&lt;label_file&gt;\n\tName of the labels output file. This text file will contain six tab-separated columns \n\t(without a header line): a column of cluster numbers, a column of short labels, a column \n\tof long labels, a column of keywords, a column of descriptions, and a column of Wikipedia \n\tpage links. Cluster numbers are integers starting at zero.\n&lt;server&gt;\n\tSQL Server server name. A connection will be made using integrated authentication.\n&lt;database&gt;\n\tDatabase name.\n&lt;pub_titles_table&gt;\n\tName of the publication titles input table. This table must have two columns: cluster_no \n\tand pub_titles. The cluster numbers in the first column must be integers starting at zero. \n\tThe publication titles in the second column (e.g., the titles of a sample of 100 \n\tpublications) must be concatenated into a single string.\n&lt;label_table&gt;\n\tName of the labels output table. This table will have six columns: cluster_no, \n\tshort_label, long_label, keywords, summary, and wikipedia_url. Cluster numbers are \n\tintegers starting at zero.\n&lt;api_key&gt;\n\tOpenAI API key.\n&lt;gpt_model&gt;\n\tOpenAI GPT model. The models supported are: \'gpt-4-1106-preview\', \'gpt-4\', \n\t\'gpt-3.5-turbo-1106\', and \'gpt-3.5-turbo\'.\n&lt;print_labeling&gt;\n\tBoolean indicating whether the generated publication classification labeling should be \n\tprinted to the standard output or not.\n"</code></td>
+</tr>
+</tbody>
+</table>
+</li>
+</ul>
+</div>
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="overview-summary.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
+<li><a href="constant-values.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html
@@ -0,0 +1,121 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http:https://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<title>Deprecated List (publicationclassificationlabeling 385fc20 API)</title>
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="Deprecated List (publicationclassificationlabeling 385fc20 API)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="overview-summary.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li class="navBarCell1Rev">Deprecated</li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li>
+<li><a href="deprecated-list.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h1 title="Deprecated API" class="title">Deprecated API</h1>
+<h2 title="Contents">Contents</h2>
+</div>
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="overview-summary.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li class="navBarCell1Rev">Deprecated</li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li>
+<li><a href="deprecated-list.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>