Highlight.php

<?php
/*
Copyright (C) 2014, 2018 Siemens AG
Authors: Andreas Würl, Daniele Fognini

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
version 2 as published by the Free Software Foundation.

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 General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
*/

namespace Fossology\Lib\Data;

use Fossology\Lib\Html\HtmlElement;

class Highlight
{
  const MATCH = "M";
  const CHANGED = "MC";
  const ADDED = "MA";
  const DELETED = "MD";
  const SIGNATURE = "S";
  const KEYWORD = "K";
  const BULK = "B";

  const COPYRIGHT = "C";
  const URL = "U";
  const EMAIL = "E";
  const AUTHOR = "A";
  const IP = "I";
  const ECC = "X";
  const KEYWORDOTHERS = "KW";
  const UNDEFINED = "any";

  private $start;
  private $end;
  private $type;
  private $licenseId;
  private $refStart;
  private $refEnd;
  private $infoText;
  private $htmlElement;

  function __construct($start, $end, $type, $refStart=-1, $refEnd=-1, $infoText = "", $htmlElement = null)
  {
    $this->start = $start;
    $this->end = $end;
    $this->type = $type;
    $this->refStart = $refStart;
    $this->refEnd = $refEnd;
    $this->infoText = $infoText;
    $this->htmlElement = $htmlElement;

    $this->licenseId = null;
  }

  public function getStart()
  {
    return $this->start;
  }

  public function getEnd()
  {
    return $this->end;
  }

  public function getType()
  {
    return $this->type;
  }

  public function setLicenseId($licenseId)
  {
    $this->licenseId = $licenseId;
  }

  public function getLicenseId()
  {
    return $this->licenseId;
  }

  public function hasLicenseId()
  {
    return $this->licenseId != null;
  }

  public function isPersistent()
  {
    return $this->licenseId == null;
  }


  public function getRefStart()
  {
    return $this->refStart;
  }

  private function hasRef()
  {
    return $this->getRefStart() >= 0;
  }

  public function getRefEnd()
  {
    return $this->refEnd;
  }

  public function getRefLength()
  {
    return max(0, $this->refEnd - $this->refStart);
  }

  public function setInfoText($infoText)
  {
    $this->infoText = $infoText;
  }

  public function getInfoText()
  {
    return $this->infoText;
  }

  public function getHtmlElement()
  {
    return $this->htmlElement;
  }


  public function __toString()
  {
    return "Highlight("
      . $this->start . "-" . $this->end
      . ", type=" . $this->type
      . ", id=" . $this->licenseId .
      ($this->hasRef() ? ":". $this->refStart . "-" . $this->refEnd : "")
      .")";
  }
}