Database (fiebdc3 parser API 0.1.0-SNAPSHOT API)

java.lang.Object
- com.disid.fiebdc3.Database

public class Database
extends Object

Contains the data of a Fiebdc 3 file.

A database has is composed of a root Concept, which itself might be composed of child Concepts:

 database
 '-> list of concepts
 '-> root concept breakdown (related to a concept)
     |-> child concept breakdown 1 (related to a concept, might have chapter or workunit as children)
     |   '-> grandson concept breakdown (related to a concept)
     |       |-> measurement 1
     |       |-> measurement 2
     |       ...
     |       '-> measurement n 
     |-> child concept breakdown 2 (related to a concept)
     ...
     '-> child concept breakdown n (related to a concept)

This class is also a factory for the elements it includes, so Concept s and Measurements can only be created through a Database.

Author:: DiSiD Team

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Database.Charset
Enumeration of the available charset options for the Fiebdc3 file.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Database.Charset` Enumeration of the available charset options for the Fiebdc3 file.

Constructor Summary

Constructors
Constructor and Description

Database()

Constructors
Constructor and Description
`Database()`

Method Summary

Methods
Modifier and Type	Method and Description
`ConceptBreakdown`	`addConceptBreakdown(String code)`
`ConceptBreakdown`	`addConceptBreakdown(String parentCode, String code)`
`Measurement`	`createMeasurement()` Creates a new measurement and adds it to the database, without bein setted to a concept.
`Date`	`getCertDate()` Spec definition: FECHA CERTIFICACIÓN: Fecha de la certificación indicada en el campo número certificación.
`int`	`getCertNum()` Spec definition: NÚMERO CERTIFICACIÓN: Valor numérico indicando el orden de la certificación (1, 2, 3,...)
`Database.Charset`	`getCharset()` Spec definition: JUEGO_CARACTERES: Asigna si el juego de caracteres a emplear es el definido para D.O.S., cuyos identificadores serán 850 ó 437, o es el definido para Windows, cuyo identificador será ANSI.
`String`	`getComments()` Spec definition: COMENTARIO: Contenido del archivo (base, obra...).
`Concept`	`getConcept(ConceptBreakdown bd)` Returns the concept related to a concept breakdown.
`Concept`	`getConcept(String code)` Returns the concept with the given code in the database.
`String`	`getFileFormat()` Spec definition: VERSION_FORMATO: VERSION del formato del archivo, la actual es FIEBDC-3/2007
`String`	`getFileProperty()` Spec definition: PROPIEDAD_ARCHIVO: Redactor de la base de datos u obra, fecha, …
`String`	`getGeneratedBy()` Spec definition: PROGRAMA_EMISION: Programa y/o empresa que genera los ficheros en formato BC3.
`String`	`getHeader()` Spec definition: CABECERA: Título general de los ROTULOS_IDENTIFICACION.
`int`	`getInfoType()` Spec definition: TIPO INFORMACIÓN: Índice del tipo de información a intercambiar.
`Concept`	`getOrAddConcept(String code)` Returns the concept with the given code in the database, or creates a new one if it didn't exist.
`ConceptBreakdown`	`getRoot()` Returns the database root `Concept`.
`boolean`	`hasOrphanedConceptBreakdowns()` Returns if there are any orphan concept breakdowns pending to be organized.
`boolean`	`hasOrphanedMeasurements()` Returns if there are any orphan measurements pending to be setted to a concept.
`void`	`setCertDate(Date certDate)`
`void`	`setCertNum(int certNum)`
`void`	`setCharset(Database.Charset charset)`
`void`	`setComments(String comments)`
`void`	`setFileFormat(String fileFormat)`
`void`	`setFileProperty(String fileProperty)`
`void`	`setGeneratedBy(String generatedBy)`
`void`	`setHeader(String header)`
`void`	`setInfoType(int infoType)`
`void`	`setMeasurement(String conceptCode, Measurement measurement)` Sets a Measurement to the related Concept.
`ConceptBreakdown`	`setRoot(String code)` Creates and sets a new root concept breakdown for the database.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Database
```
public Database()
```
- Method Detail
  - getFileProperty
```
public String getFileProperty()
```
    Spec definition:
    PROPIEDAD_ARCHIVO: Redactor de la base de datos u obra, fecha, …
    
    Returns:
    the file writer or owner
  - setFileProperty
```
public void setFileProperty(String fileProperty)
```
  - getFileFormat
```
public String getFileFormat()
```
    Spec definition:
    VERSION_FORMATO: VERSION del formato del archivo, la actual es FIEBDC-3/2007
  - setFileFormat
```
public void setFileFormat(String fileFormat)
```
  - getGeneratedBy
```
public String getGeneratedBy()
```
    Spec definition:
    PROGRAMA_EMISION: Programa y/o empresa que genera los ficheros en formato BC3.
  - setGeneratedBy
```
public void setGeneratedBy(String generatedBy)
```
  - getHeader
```
public String getHeader()
```
    Spec definition:
    CABECERA: Título general de los ROTULOS_IDENTIFICACION.
  - setHeader
```
public void setHeader(String header)
```
  - getCharset
```
public Database.Charset getCharset()
```
    Spec definition:
    JUEGO_CARACTERES: Asigna si el juego de caracteres a emplear es el definido para D.O.S., cuyos identificadores serán 850 ó 437, o es el definido para Windows, cuyo identificador será ANSI. En caso de que dicho campo esté vacío se interpretará, por omisión, que el juego de caracteres a utilizar será el 850 por compatibilidad con versiones anteriores.
  - setCharset
```
public void setCharset(Database.Charset charset)
```
  - getComments
```
public String getComments()
```
    Spec definition:
    COMENTARIO: Contenido del archivo (base, obra...).
  - setComments
```
public void setComments(String comments)
```
  - getInfoType
```
public int getInfoType()
```
    Spec definition:
    TIPO INFORMACIÓN: Índice del tipo de información a intercambiar. Se definen los siguientes tipos: 1 Base de datos. 2 Presupuesto. 3 Certificación (a origen). 4 Actualización de base de datos.
  - setInfoType
```
public void setInfoType(int infoType)
```
  - getCertNum
```
public int getCertNum()
```
    Spec definition:
    NÚMERO CERTIFICACIÓN: Valor numérico indicando el orden de la certificación (1, 2, 3,...) Solo tiene sentido cuando el tipo de información es Certificación.
  - setCertNum
```
public void setCertNum(int certNum)
```
  - getCertDate
```
public Date getCertDate()
```
    Spec definition:
    FECHA CERTIFICACIÓN: Fecha de la certificación indicada en el campo número certificación. Solo tiene sentido cuando el tipo de información es Certificación. La fecha se definirá con el mismo formato que el campo DDMMAAAA de este registro
  - setCertDate
```
public void setCertDate(Date certDate)
```
  - getRoot
```
public ConceptBreakdown getRoot()
```
    Returns the database root Concept.
    
    Returns:
    the main root concept
  - setRoot
```
public ConceptBreakdown setRoot(String code)
```
    Creates and sets a new root concept breakdown for the database.
    
    Parameters:
    code - to identify the concept of the breakdown
    
    Returns:
    the new root concept breakdown
  - addConceptBreakdown
```
public ConceptBreakdown addConceptBreakdown(String code)
```
  - addConceptBreakdown
```
public ConceptBreakdown addConceptBreakdown(String parentCode,
                                   String code)
```
  - getConcept
```
public Concept getConcept(String code)
```
    Returns the concept with the given code in the database.
    
    Parameters:
    code - of the Concept
    
    Returns:
    the concept with the given code
  - getConcept
```
public Concept getConcept(ConceptBreakdown bd)
```
    Returns the concept related to a concept breakdown.
    
    Parameters:
    bd - the concept breakdown
    
    Returns:
    the related concept
  - getOrAddConcept
```
public Concept getOrAddConcept(String code)
```
    Returns the concept with the given code in the database, or creates a new one if it didn't exist.
    
    Parameters:
    code - of the Concept
    
    Returns:
    the concept with the given code
  - hasOrphanedConceptBreakdowns
```
public boolean hasOrphanedConceptBreakdowns()
```
    Returns if there are any orphan concept breakdowns pending to be organized.
    
    Returns:
    if there are any orphan concept breakdowns pending to be organized
  - hasOrphanedMeasurements
```
public boolean hasOrphanedMeasurements()
```
    Returns if there are any orphan measurements pending to be setted to a concept.
    
    Returns:
    if there are any orphan measurements pending to be setted to a concept
  - createMeasurement
```
public Measurement createMeasurement()
```
    Creates a new measurement and adds it to the database, without bein setted to a concept.
    
    Returns:
    the new Measurement
  - setMeasurement
```
public void setMeasurement(String conceptCode,
                  Measurement measurement)
```
    Sets a Measurement to the related Concept.
    
    Parameters:
    conceptCode - code of the Concept to set the Measure to
    measurement - to set to the Concept
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Database

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Database

Method Detail

getFileProperty

setFileProperty

getFileFormat

setFileFormat

getGeneratedBy

setGeneratedBy

getHeader

setHeader

getCharset

setCharset

getComments

setComments

getInfoType

setInfoType

getCertNum

setCertNum

getCertDate

setCertDate

getRoot

setRoot

addConceptBreakdown

addConceptBreakdown

getConcept

getConcept

getOrAddConcept

hasOrphanedConceptBreakdowns

hasOrphanedMeasurements

createMeasurement

setMeasurement

toString