Rename isSinkCandidate (and a related predicate) to isCandidate.

This reflects the fact that these predicates also deal with source candidates.

Author: Max Schaefer

java/ql/automodel/src/AutomodelApplicationModeExtractCandidates.ql

@@ -63,7 +63,7 @@ where
   not exists(CharacteristicsImpl::UninterestingToModelCharacteristic u |
     u.appliesToEndpoint(endpoint)
   ) and
-  CharacteristicsImpl::isSinkCandidate(endpoint, _) and
+  CharacteristicsImpl::isCandidate(endpoint, _) and
   endpoint =
     getSampleForSignature(9, package, type, subtypes, name, signature, input, output,
       isVarargsArray, extensibleType) and

java/ql/automodel/src/AutomodelFrameworkModeExtractCandidates.ql

@@ -25,7 +25,7 @@ where
   not exists(CharacteristicsImpl::UninterestingToModelCharacteristic u |
     u.appliesToEndpoint(endpoint)
   ) and
-  CharacteristicsImpl::isSinkCandidate(endpoint, _) and
+  CharacteristicsImpl::isCandidate(endpoint, _) and
   // If a node is already a known sink for any of our existing ATM queries and is already modeled as a MaD sink, we
   // don't include it as a candidate. Otherwise, we might include it as a candidate for query A, but the model will
   // label it as a sink for one of the sink types of query B, for which it's already a known sink. This would result in

java/ql/automodel/src/AutomodelSharedCharacteristics.qll

@@ -117,13 +117,14 @@ module SharedCharacteristics<CandidateSig Candidate> {
   }
 
   /**
-   * Holds if the candidate sink `candidateSink` should be considered as a possible sink of type `sinkType`, and
-   * classified by the ML model. A candidate sink is a node that cannot be excluded from `sinkType` based on its
-   * characteristics.
+   * Holds if the given `endpoint` should be considered as a candidate for type `endpointType`,
+   * and classified by the ML model.
+   *
+   * A candidate is an endpoint that cannot be excluded from `endpointType` based on its characteristics.
    */
-  predicate isSinkCandidate(Candidate::Endpoint candidateSink, Candidate::EndpointType sinkType) {
+  predicate isCandidate(Candidate::Endpoint candidateSink, Candidate::EndpointType sinkType) {
     not sinkType instanceof Candidate::NegativeEndpointType and
-    not exists(getAReasonSinkExcluded(candidateSink, sinkType))
+    not exists(getAnExcludingCharacteristic(candidateSink, sinkType))
   }
 
   /**
@@ -139,15 +140,14 @@ module SharedCharacteristics<CandidateSig Candidate> {
   }
 
   /**
-   * Gets the list of characteristics that cause `candidateSink` to be excluded as an effective sink for a given sink
-   * type.
+   * Gets a characteristics that disbar `endpoint` from being a candidate for `endpointType`.
    */
-  EndpointCharacteristic getAReasonSinkExcluded(
-    Candidate::Endpoint candidateSink, Candidate::EndpointType sinkType
+  EndpointCharacteristic getAnExcludingCharacteristic(
+    Candidate::Endpoint endpoint, Candidate::EndpointType endpointType
   ) {
     // An endpoint is a sink candidate if none of its characteristics give much indication whether or not it is a sink.
-    not sinkType instanceof Candidate::NegativeEndpointType and
-    result.appliesToEndpoint(candidateSink) and
+    not endpointType instanceof Candidate::NegativeEndpointType and
+    result.appliesToEndpoint(endpoint) and
     (
       // Exclude endpoints that have a characteristic that implies they're not sinks for _any_ sink type.
       exists(float confidence |
@@ -158,7 +158,7 @@ module SharedCharacteristics<CandidateSig Candidate> {
       // Exclude endpoints that have a characteristic that implies they're not sinks for _this particular_ sink type.
       exists(float confidence |
         confidence >= mediumConfidence() and
-        result.hasImplications(sinkType, false, confidence)
+        result.hasImplications(endpointType, false, confidence)
       )
     )
   }