/**
  * Ustawia następny stan w przepływie dokumentów <br>
  * Pozwala ustawiać daty tych legendarnych wydarzeń <br>
  * Pozwala na walidacje, np, aby dokument usiągnął status SUCCEDDED musi zawierac referencje do
  * plików wynikowych (naturalnie nie jest to zaimplementowane)
  */
 public void nextState() throws WorkflowException {
   int o = state.ordinal();
   if (o >= RequestState.values().length) {
     throw new WorkflowException("Last stage of worklow has been already obtained.");
   }
   if (o == RequestState.SUCCEEDED.ordinal()) {
     throw new WorkflowException("Document already marked as successfully translated.");
   } else {
     timeStamps[o++] = new Date();
     state = RequestState.values()[o];
   }
 }
  public String toString() {
    StringBuilder result = new StringBuilder();
    result.append("\tRequest no: " + requestId + "\n");
    if (langPair != null) {
      result.append("\tSource language: " + langPair.getFromLang() + "\n");
      result.append("\tTarget language: " + langPair.getToLang() + "\n");
    } else {
      result.append("\tlanguages unknown\n");
    }
    result.append("\tstate: " + state);
    result.append("\tdocument to translate: " + sourceDocument);
    result.append("\tdestination document: " + destinationDocument);
    result.append("\tactions happened in lifecycle:");
    for (int i = 0; i < timeStamps.length; ++i) {
      result.append("\t\t" + RequestState.values()[i] + ": " + timeStamps[i] + "\n");
    }

    return result.toString();
  }
/**
 * Obiekt identyfikuje pojedyncze zamówienie na przekład, dotyczące jednego pliku. Posiada komplet
 * informacji podczas całego czasu przetwarzania zamówienia.
 */
@Entity
@Table(name = "TRANSLATION_ORDER")
public class TranslationOrder implements java.io.Serializable {

  private static final long serialVersionUID = -6226478864052959723L;

  /** Status zamównienia w przepływie. */
  public enum RequestState {
    /** Tuż po utworzeniu. */
    BEFORE_PROCESSING,

    /** Konwersja do xliffa. */
    UNDER_CONVERSION,

    /** Zamówienie wysłane do właściwiego tłumaczenia do serwisów zewnętrznych. */
    UNDER_PROCESSING,

    /** Rekonwersja z xliffa na wyjściowy format. */
    UNDER_RECONVERSION,

    /** Zamówienie zostało przetworzone z sukcesem. */
    SUCCEEDED,

    /** Oznacza, że podczas przetwarzania wystąpiły błędy. */
    FAILED
  }

  private RequestState state = RequestState.BEFORE_PROCESSING;

  /** Referencja do dokumentu źródłowego */
  private DocumentRefWrapper sourceDocument;

  /** Referencja do dokumentu wynikowego */
  private DocumentRefWrapper destinationDocument;

  /** Wiadomo co */
  private LangPair langPair;

  /**
   * Nazwa dokumentu wynikowego
   *
   * <p>sam dokument może jeszcze nie istnieć, ale trzeba znać jego nazwe
   */
  private String destinationDocumentName;

  /** unikalny numer zamówienie */
  private Long requestId = IosrRandomGenerator.nextLong();

  /** Jakość zleconego tłumaczenia */
  private String quality;

  /** identyfikator web servisu */
  private Long wsId;

  /** Lokalizacja pliku, bądź zawartość skeletona */
  private Serializable skeleton;

  /** Lokalizacja pliku, bądź zawartość xliffa */
  private String xliff;

  /** Wiadomość, jakby zaszła jakaś konieczność, np. błąd */
  private String message;

  /** Detekcja języka */
  private boolean languageDetection;

  /**
   * daty, kiedy co się stało,
   *
   * <p>można odczytać tylko poprzez toString
   */
  private Date[] timeStamps = new Date[RequestState.values().length];

  /** zawiera status okreslajacy postep translacji */
  private TranslationStatus status = TranslationStatus.NOT_STARTED;

  public String toString() {
    StringBuilder result = new StringBuilder();
    result.append("\tRequest no: " + requestId + "\n");
    if (langPair != null) {
      result.append("\tSource language: " + langPair.getFromLang() + "\n");
      result.append("\tTarget language: " + langPair.getToLang() + "\n");
    } else {
      result.append("\tlanguages unknown\n");
    }
    result.append("\tstate: " + state);
    result.append("\tdocument to translate: " + sourceDocument);
    result.append("\tdestination document: " + destinationDocument);
    result.append("\tactions happened in lifecycle:");
    for (int i = 0; i < timeStamps.length; ++i) {
      result.append("\t\t" + RequestState.values()[i] + ": " + timeStamps[i] + "\n");
    }

    return result.toString();
  }

  /** Konstruktor tylko na potrzeby na mechanizmów persystencji. */
  public TranslationOrder() {
    timeStamps[0] = new Date();
  }

  /** Rekomendowany konstruktor. */
  public TranslationOrder(
      DocumentRefWrapper sourceDocument,
      LangPair langPair,
      String destinationDocumentName,
      String quality,
      Long wsId,
      boolean languageDetection) {
    super();
    this.sourceDocument = sourceDocument;
    this.langPair = langPair;
    this.destinationDocumentName = destinationDocumentName;
    this.quality = quality;
    this.wsId = wsId;
    this.languageDetection = languageDetection;
    timeStamps[0] = new Date();
  }

  /**
   * Ustawia następny stan w przepływie dokumentów <br>
   * Pozwala ustawiać daty tych legendarnych wydarzeń <br>
   * Pozwala na walidacje, np, aby dokument usiągnął status SUCCEDDED musi zawierac referencje do
   * plików wynikowych (naturalnie nie jest to zaimplementowane)
   */
  public void nextState() throws WorkflowException {
    int o = state.ordinal();
    if (o >= RequestState.values().length) {
      throw new WorkflowException("Last stage of worklow has been already obtained.");
    }
    if (o == RequestState.SUCCEEDED.ordinal()) {
      throw new WorkflowException("Document already marked as successfully translated.");
    } else {
      timeStamps[o++] = new Date();
      state = RequestState.values()[o];
    }
  }

  /**
   * Coś się zepsuło - najlepiej odznaczyć to w ten sposób, bo możliwe że zostaną podjęte jakieś
   * specjalne działa, np logowanie!
   */
  public void markAsFailed(String failureReason) {
    this.state = RequestState.FAILED;
    message = failureReason;
    IosrLogger.log(
        this.getClass(), "Failed to translate document: " + sourceDocument.getName(), Level.FATAL);
  }

  /**
   * Przy zwrocie wyniku translacji, zapisuje xliffa do pliku i zwraca go jako wynik.
   *
   * @param dh - wrapper dla przetłumaczonej treści
   */
  public File saveResultFile(DataHandler dh) throws IOException {
    /*
     * File xliff = new File(getXliff()); String name = xliff.getName();
     * name = name.replaceFirst(".old", "");
     */

    File xliffResult = new File(getXliff() + ".transl");
    if (!xliffResult.exists()) xliffResult.createNewFile();

    FileOutputStream out = new FileOutputStream(xliffResult);

    dh.writeTo(out);
    out.flush();
    out.close();

    return xliffResult;
  }

  // gettery i setter

  /** Identyfikator zamówienia. */
  @Id
  public Long getRequestId() {
    return requestId;
  }

  /** Bieżący stan zamówienia. */
  @Enumerated(EnumType.STRING)
  public RequestState getState() {
    return state;
  }

  /** @return Obiekt opisujący docelową lokalizację pliku z przetłumaczoną treścią. */
  @Embedded
  @AttributeOverrides({
    @AttributeOverride(name = "name", column = @Column(name = "distName")),
    @AttributeOverride(name = "path", column = @Column(name = "distPath")),
    @AttributeOverride(name = "type", column = @Column(name = "distType"))
  })
  public DocumentRefWrapper getDestinationDocument() {
    return destinationDocument;
  }

  public void setDestinationDocument(DocumentRefWrapper destinationDocument) {
    this.destinationDocument = destinationDocument;
  }

  /** @deprecated */
  @Transient
  public Serializable getSkeleton() {
    return skeleton;
  }

  public void setSkeleton(Serializable skeleton) {
    this.skeleton = skeleton;
  }

  /** @return Dokument w formacie XLIFF (XML) charakterystyczny dla treści zamówienia. */
  public String getXliff() {
    return xliff;
  }

  public void setXliff(String xliff) {
    this.xliff = xliff;
  }

  /** @return Obiekt opisujący źródłowy plik z treścią do przetłumaczenia. */
  @Embedded
  @AttributeOverrides({
    @AttributeOverride(name = "name", column = @Column(name = "srcName")),
    @AttributeOverride(name = "path", column = @Column(name = "srcPath")),
    @AttributeOverride(name = "type", column = @Column(name = "srcType"))
  })
  public DocumentRefWrapper getSourceDocument() {
    return sourceDocument;
  }

  /** @return Para języków - źródłowy oraz docelowy. */
  @OneToOne(
      cascade = {CascadeType.ALL},
      fetch = FetchType.EAGER,
      optional = true)
  public LangPair getLangPair() {
    return langPair;
  }

  /** @return Nazwa dokumentu docelowego. */
  public String getDestinationDocumentName() {
    return destinationDocumentName;
  }

  /** @return Docelowa jakość przekładu. */
  public String getQuality() {
    return quality;
  }

  /** @return identyfikator zewnętrznego web service'u tłumaczącego. */
  public Long getWsId() {
    return wsId;
  }

  /** @return wiadomość ze szczegółami błędu, o ile wystąpił. */
  public String getMessage() {
    return message;
  }

  /** @return czy użytkownik zarządał wykrycia języka źródłowego. */
  public boolean getLanguageDetection() {
    return languageDetection;
  }

  public void setMessage(String message) {
    this.message = message;
  }

  /** @return tablica dat opisujące momenty z cyklu przetwarzania zamówienia. */
  @Lob
  public Date[] getTimeStamps() {
    return timeStamps;
  }

  public void setTimeStamps(Date[] timeStamps) {
    this.timeStamps = timeStamps;
  }

  public void setState(RequestState state) {
    this.state = state;
  }

  public void setSourceDocument(DocumentRefWrapper sourceDocument) {
    this.sourceDocument = sourceDocument;
  }

  public void setLangPair(LangPair langPair) {
    this.langPair = langPair;
  }

  public void setDestinationDocumentName(String destinationDocumentName) {
    this.destinationDocumentName = destinationDocumentName;
  }

  public void setRequestId(Long requestId) {
    this.requestId = requestId;
  }

  public void setQuality(String quality) {
    this.quality = quality;
  }

  public void setWsId(Long wsId) {
    this.wsId = wsId;
  }

  public void setLanguageDetection(boolean languageDetection) {
    this.languageDetection = languageDetection;
  }

  /** na potrzeby wyswietlania */
  @Transient
  public Date getBefore() {
    return timeStamps[0];
  }

  /** na potrzeby wyswietlania */
  @Transient
  public Date getConversion() {
    return timeStamps[1];
  }

  /** na potrzeby wyswietlania */
  @Transient
  public Date getProcessing() {
    return timeStamps[2];
  }

  /** na potrzeby wyswietlania */
  @Transient
  public Date getReconversion() {
    return timeStamps[3];
  }

  /** na potrzeby wyswietlania */
  @Transient
  public Date getSucceeded() {
    return timeStamps[4];
  }

  /** na potrzeby wyswietlania */
  @Transient
  public Date getFailed() {
    return timeStamps[5];
  }

  /** @return bieżący status zamówienia. */
  public TranslationStatus getStatus() {
    return status;
  }

  public void setStatus(TranslationStatus status) {
    this.status = status;
  }
}