Contents

module BELParser
  module Language
    # Function allows you to describe the type of BEL Term.
    #
    # BEL Terms are composed of BEL Functions and entity definitions
    # referenced using BEL Namespace identifiers. Each BEL Term represents
    # either an abundance of a biological entity, the abundance of human AKT1
    # for example, or a biological process such as cardiomyopathy.
    module Function
      def short
        raise NotImplementedError, "#{__method__} is not implemented."
      end

      def long
        raise NotImplementedError, "#{__method__} is not implemented."
      end

      def return_type
        raise NotImplementedError, "#{__method__} is not implemented."
      end

      def description
        raise NotImplementedError, "#{__method__} is not implemented."
      end

      def signatures
        raise NotImplementedError, "#{__method__} is not implemented."
      end

      # Indicates whether this function is deprecated. Override in your
      # function to mark as deprecated.
      #
      # @return [Boolean] false
      def deprecated?
        false
      end

      def ===(other)
        return false if other.nil?
        short == other || long == other
      end

      def to_sym(form = :short)
        _form_value(form)
      end

      def to_s(form = :short)
        value = _form_value(form)
        return nil unless value
        value.to_s
      end

      def to_h(hash = {})
        hash.merge!({
          'short'       => short,
          'long'        => long,
          'return_type' => return_type.to_sym.to_s,
          'signatures'  => signatures.map { |sig| sig.string_form },
          'description' => description
        })
      end

      private

      def _form_value(form = :short)
        case form
        when :short
          short
        when :long
          long
        end
      end
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
bel_parser-1.0.8-java	lib/bel_parser/language/function.rb
bel_parser-1.0.8	lib/bel_parser/language/function.rb
bel_parser-1.0.7-java	lib/bel_parser/language/function.rb
bel_parser-1.0.7	lib/bel_parser/language/function.rb
bel_parser-1.0.6-java	lib/bel_parser/language/function.rb
bel_parser-1.0.6	lib/bel_parser/language/function.rb