Commit cd50b3bb authored by R.W.Majeed's avatar R.W.Majeed

Fixed javadoc errors

parent f120f657
......@@ -6,7 +6,6 @@ import java.io.IOException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
......@@ -56,7 +55,7 @@ public class Store implements Ontology, Plugin {
* Configuration keys have the form {@code rdf.baseURI}, {@code rdf.file.1}, {@code rdf.format.1}.
* rdf.file is mandatory, other parameters are optional.
* <p>
* {@code rdf.baseURI} specifies a URI to resolve any relative URIs that are in the data against. See {@link #Store(Collection, String)}.
* {@code rdf.baseURI} specifies a URI to resolve any relative URIs that are in the data against. See {@link #Store(Iterable, String)}.
* <p>
* {@code rdf.skosScheme} can specify the skos:ConceptScheme to find top concepts and unique notations
*
......
......@@ -58,7 +58,7 @@ public class Import implements AutoCloseable{
/**
* Connect to the i2b2 database.
* The current implementation supports only Postgres databases for i2b2 versions >= 1.7.05(?)
* The current implementation supports only Postgres databases for i2b2 versions &gt;= 1.7.05(?)
* <p>
* Two connections are established: One for access to the metadata schema, the second for access to concept_dimension in the data schema.
* Connection arguments start with {@code meta.jdbc.} or {@code data.jdbc.}.
......
......@@ -46,6 +46,7 @@ public interface Extension<T>{
* <p>
* Some extensions do not support independent instances. In this case, all
* calls to this method will result in an {@link UnsupportedOperationException}.
* @param args arguments for the static instance. Usually id and additional contexts.
* @return new instance
* @throws UnsupportedOperationException if instance creation without {@link Observation} is not possible.
* @throws IllegalArgumentException if given arguments are unsuitable to instantiate/identify this type.
......
......@@ -48,6 +48,7 @@ public interface ObservationFactory {
* Extensions can be accessed through either via {@link Observation#getExtension(Class)}
* or via an {@link ExtensionAccessor}. The latter method is faster, because no hash
* lookup of the extensionType needs to be performed.
* @param <T> extension type
*
* @param extensionType type to get an accessor for
* @return extension accessor or null if the extension is not available
......
......@@ -121,6 +121,7 @@ public class StoredExtensionType implements IdExtensionType, ExternalSourceType{
* Get an iterator over all cached instances marked as dirty.
* Calling the {@link Iterator#remove()} method will clear the
* dirty flag for the current element (previously returned by next).
* @param <T> extension type
*
* @param allElements enumerator over all types, dirty or not
* @return iterator which returns only dirty type instances.
......
......@@ -70,6 +70,7 @@ public class ObservationFactoryImpl implements ObservationFactory{
* Get the extension type instance for a given observation. Returns a cached
* object, if the instance was already requested before. Otherwise, a new
* instance is generated with the help of the extension.
* @param <T> extension type
*
* @param observation observation for which the extension type is requested.
* @param extensionType extension type to request. E.g. the type supplied to the subclass of Extension.
......
......@@ -330,6 +330,7 @@ public class ObservationImpl implements Observation, Cloneable{
* Removes information from this observation which is already contained in the provided context
* @param patientId patient context
* @param encounterId encounter context
* @param startTime start time
* @param source source context
*/
public void removeContext(String patientId, String encounterId, DateTimeAccuracy startTime, ExternalSourceType source){
......
......@@ -22,7 +22,7 @@ import de.sekmi.histream.ext.Visit;
*
* <p>Algorithm</p>
* <ol>
* <li>read first patient and first visit. -> currentPatient,
* <li>read first patient and first visit. -&gt; currentPatient,
* currentVisit</li>
*
* <li>For each concept table (including patient and visit tables):
......
......@@ -15,6 +15,7 @@ import de.sekmi.histream.etl.ParseException;
* A column does not need a name, if it has a constant-value assigned.
*
* @author marap1
* @param <T> column type
*
*/
@XmlTransient
......@@ -85,6 +86,7 @@ public abstract class Column<T> {
*
* @param value input value. e.g. from text table column
* @return output type representing the input value
* @throws ParseException on errors with regular expressions
*/
public Object preprocessValue(Object value)throws ParseException{
if( constantValue != null ){
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment