Skip to content

Commit

Permalink
[#258] Remove useless comments of parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
blcham committed Sep 13, 2024
1 parent 4aba5c6 commit c1d2865
Show file tree
Hide file tree
Showing 7 changed files with 1 addition and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,24 +31,18 @@ public class ApplyConstructModule extends AnnotatedAbstractModule {

private static final Logger log = LoggerFactory.getLogger(ApplyConstructModule.class);


//sml:constructQuery
@Parameter(iri = SML.constructQuery)
private List<Resource> constructQueries;

//sml:replace
@Parameter(iri = SML.replace)
private boolean isReplace = false;

//kbss:parseText
/**
* Whether the query should be taken from sp:text property instead of from SPIN serialization
*/
@Parameter(iri = KBSS_MODULE.is_parse_text)
private boolean parseText = false;


//kbss:iterationCount
/**
* Maximal number of iterations of the whole rule set. 0 means 0 iterations. The actual number of iterations can be smaller,
* if no new inferences are generated any more.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ public class BindBySelectModule extends AnnotatedAbstractModule {
@Parameter(iri = SML.selectQuery)
private Select selectQuery;

//sml:replace
@Parameter(iri = SML.replace)
private boolean isReplace = false;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ public class RetrievePrefixesModule extends AnnotatedAbstractModule {
private static final Logger log = LoggerFactory.getLogger(RetrievePrefixesModule.class);
private static final String TYPE_URI = KBSS_MODULE.uri + "retrieve-prefixes";

//sml:replace
@Parameter(iri = SML.replace)
private boolean isReplace = false;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,27 +23,24 @@ public abstract class ApplyConstructAbstractModule extends AnnotatedAbstractModu

private static final String TYPE_URI = KBSS_MODULE.uri + "abstract-apply-construct";
private static final String PROPERTY_PREFIX_URI = KBSS_MODULE.uri;
//sml:constructQuery

// TODO - this parameter is reused in ApplyConstructWithChunkedValuesAndScrollableCursorModule. There the comment should be extended by a note, i.e. "The construct queries with markers #${VALUES} and #${LIMIT_OFFSET}."
@Parameter(iri = SML.constructQuery, comment = "SPARQL Construct query (sp:Construct)" +
" that should be executed by this module. The query is read from sp:text property." +
" The output of query execution is returned by the module.")
protected List<Resource> constructQueries;

//sml:replace
@Parameter(iri = SML.replace, comment = "Specifies whether a module should overwrite triples" +
" from its predecessors. When set to true (default is false), it prevents" +
" passing through triples from the predecessors.")
protected boolean isReplace;

//kbss:parseText
@Parameter(iri = KBSS_MODULE.is_parse_text,
comment = "Whether the query should be taken from sp:text property instead of from SPIN serialization," +
" default is true."
)
protected boolean parseText;

//kbss:iterationCount
@Parameter(iri = KBSS_MODULE.has_max_iteration_count,
comment =
"Maximal number of iterations of the whole rule set. 0 means 0 iterations. The actual number of iterations can be smaller,\n" +
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,30 +111,24 @@ public class TabularModule extends AbstractModule {
private final Property P_SOURCE_RESOURCE_FORMAT = getSpecificParameter("source-resource-format");
private final Property P_PROCESS_TABLE_AT_INDEX = getSpecificParameter("process-table-at-index");

//sml:replace
@Parameter(iri = SML.replace, comment = "Specifies whether a module should overwrite triples" +
" from its predecessors. When set to true (default is false), it prevents" +
" passing through triples from the predecessors.")
private boolean isReplace;

@Parameter(iri = PARAM_URL_PREFIX + "source-resource-uri", comment = "URI of resource" +
" that represent tabular data (e.g. resource representing CSV file).")
//:source-resource-uri
private StreamResource sourceResource;

//:delimiter
@Parameter(iri = PARAM_URL_PREFIX + "delimiter", comment = "Column delimiter. Default value is comma ','.")
private int delimiter;

//:quote-character
@Parameter(iri = PARAM_URL_PREFIX + "quote-character", comment = "Quote character. Default is '\"' if delimiter is ',', '\\0' otherwize.")
private char quoteCharacter;

//:data-prefix
@Parameter(iri = PARAM_URL_PREFIX + "data-prefix", comment = "Data prefix")// TODO - improve comment
private String dataPrefix;

//:skip-header
@Parameter(iri = PARAM_URL_PREFIX + "skip-header", comment = "Skip header. Default is false.")
private boolean skipHeader;

Expand All @@ -144,7 +138,6 @@ public class TabularModule extends AbstractModule {
*/
private int processTableAtIndex;

//:output-mode
// TODO - revise comment
@Parameter(iri = PARAM_URL_PREFIX + "output-mode", comment = "Output mode. Default is standard-mode('http://onto.fel.cvut.cz/ontologies/lib/module/tabular/standard-mode)")
private Mode outputMode;
Expand All @@ -163,7 +156,6 @@ public class TabularModule extends AbstractModule {
*/
private ResourceFormat sourceResourceFormat = ResourceFormat.PLAIN;

//:accept-invalid-quoting
@Parameter(iri = PARAM_URL_PREFIX + "accept-invalid-quoting", comment = "Accept invalid quoting. Default is false.")
private boolean acceptInvalidQuoting;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,20 +36,17 @@ public class TarqlModule extends AbstractModule {

private static final String TARQL_PROGRAM = AppConstants.BIN_DIR + "/tarql";

//sml:constructQuery
@Parameter(iri = SML.constructQuery, comment = "The TARQL Construct queries that deliver the triples that shall be added.")
private List<Resource> constructQueries;

// TODO not used field
private String tableFilePath;

//sml:replace
@Parameter(iri = SML.replace, comment = "If set to true, the output triples will only contain the " +
"constructed triples. If no values or false are specified, the output will be the union of the input triples " +
"and the constructed triples.")
private boolean isReplace;

//sml:sourceFilePath
@Parameter(iri = SML.sourceFilePath, comment = "Source CSV file.")
private String sourceFilePath;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ public class TextAnalysisModule extends AnnotatedAbstractModule{
@Parameter(iri = TYPE_PREFIX + "language", comment = "The language of the text to be analyzed.")
private String language;

//sml:replace
@Parameter(iri = SML.replace, comment = "Replace context flag, default is false.")
private boolean isReplace = false;

Expand Down

0 comments on commit c1d2865

Please sign in to comment.