ExternalProcNodeFilter.java

/*
** Module   : ExternalProcNodeFilter.java
** Abstract : An interface to filter external-procedure graph nodes.
**
** Copyright (c) 2014-2017, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description----------------------------------
** 001 CA  20140318 Created initial version.
** 002 GES 20170509 Call graph v3.
*/

/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero 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 Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
** 
** Additional terms under GNU Affero GPL version 3 section 7:
** 
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
** 
**   0. Attribution Requirement.
** 
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
** 
**   1. No License To Use Trademarks.
** 
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
** 
**   2. No Misrepresentation of Affiliation.
** 
**     You may not represent yourself as Golden Code Development Corporation or FWD.
** 
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
** 
**   3. No Misrepresentation of Source or Origin.
** 
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/

package com.goldencode.p2j.uast;

import com.goldencode.p2j.pattern.*;
import org.apache.tinkerpop.gremlin.structure.*;

/**
 * This class name can be passed to the {@link PatternEngine} via the {@code graph-node-filter}
 * configuration parameter.  It provides a way of filtering the external-procedure nodes, to be
 * walked by a callgraph-mode {@link PatternEngine} instance.
 */
public class ExternalProcNodeFilter
implements GraphNodeFilter
{
   /**
    * Check if the given node is an external procedure.
    * 
    * @param    node
    *           The graph node.
    * 
    * @return   {@code true} if the node can be walked.
    */
   @Override
   public boolean acceptNode(Vertex node)
   {
      return node.<Integer>property("node-type").equals(ProgressParserTokenTypes.EXTERNAL_PROCEDURE);
   }

   /**
    * If the given node is an external procedure, load it and return it. Else, return {@code null}.
    * 
    * @param    id
    *           The node id in the graph, from a {@code node-id} property.
    * 
    * @return   The graph node or {@code null}.
    */
   @Override
   public Vertex acceptNode(long id)
   {
      return CallGraphHelper.findNodeById(ProgressParserTokenTypes.EXTERNAL_PROCEDURE, id);
   }
}