csbase.logic

Class ProgressDataParser

java.lang.Object

csbase.logic.ProgressDataParser

public class ProgressDataParser
extends java.lang.Object

Classe de tratamento de informações de progresso do comando. Analisa o texto indicado [proveniente de uma chave 'progresso...'] e extrai o progresso do comando em dois formatos: valor texto de progresso e também o valor numérico correspondente, entre 0 e 100%.

• Exemplo: Texto: "1/10" --- Retorno: { "1/10", 10 }

Se o texto não tiver um formato numérico conhecido, o valor fica Double.NaN.

• Exemplo: Texto: "Passo 1: lendo arquivo" --- Retorno: { "Passo 1: lendo arquivo", Double.NaN }

Para que seja extraído um valor numérico de progresso, espera-se que 'progressData' tenha um dos formatos abaixo:

• 1/12
• 0.3 [entre 0 e 1]
• 20% [entre 0 e 100]
• Opcionalmente um texto fixo pode ser indicado depois de um '#':
  • 1/12 #Um texto qualquer para o progresso atual
  • 10% #Um texto qualquer para o progresso atual
  • 0.3 #Um texto qualquer para o progresso atual.
    Nesses casos o texto retornado é o texto indicado, e não o texto que gerou o valor.
    • Exemplo: Texto: "1/10 #Passo 1" --- Retorno: { "Passo 1", 10 }

Constructor Summary

Constructors

Constructor and Description
ProgressDataParser()

Method Summary

Methods

Modifier and Type	Method and Description
ProgressData	extractOverallProgressData(java.util.Map<java.lang.String,java.lang.String> dynamicData, int expectedPartialProgress) Obtém a informação de progresso geral do comando.
java.util.Map<java.lang.Integer,ProgressData>	extractProgressDataMap(java.util.Map<java.lang.String,java.lang.String> dynamicData) Retorna um mapa de dados de progresso por chave numérica.
boolean	hasProgressData(java.util.Map<java.lang.String,java.lang.String> dynamicData) Determina se há informação de progresso disponível.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProgressDataParser

public ProgressDataParser()

Method Detail

hasProgressData

public boolean hasProgressData(java.util.Map<java.lang.String,java.lang.String> dynamicData)

Determina se há informação de progresso disponível.

Parameters:

dynamicData - Dados dinâmicos do comando.

Returns:

verdadeiro se há informação de progresso ou falso, caso contrário.

extractOverallProgressData

public ProgressData extractOverallProgressData(java.util.Map<java.lang.String,java.lang.String> dynamicData,
                                      int expectedPartialProgress)

Obtém a informação de progresso geral do comando.

Parameters:

dynamicData - Dados dinâmicos do comando.

expectedPartialProgress - Número de dados esperados de progresso. Utilizado para determinar se é possível calcular a informação geral de progresso a partir dos valores individuais de progresso.

Returns:

os dados gerais de progresso.

extractProgressDataMap

public java.util.Map<java.lang.Integer,ProgressData> extractProgressDataMap(java.util.Map<java.lang.String,java.lang.String> dynamicData)

Retorna um mapa de dados de progresso por chave numérica.

Parameters:

dynamicData - Dados dinâmicos do comando.

Returns:

Os dados de progresso mapeados pela chave numérica que os identificam.