org.disl.util.wiki.TablePageStep.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of disl Show documentation

disl = data integration specific language. Goal of this project is to implement groovy based domain specific language supporting modelling of data integration projects. Disl will support data modeling and data mapping including support for MDA transformations and unit testing.

There is a newer version: 1.1.2

Show newest version

/*
 * Copyright 2015 - 2017 Karel H?bl .
 *
 * This file is part of disl.
 *
 * Disl is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Disl 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 Disl.  If not, see .
 */
package org.disl.util.wiki

import org.disl.meta.Table
import org.disl.pattern.FileOutputStep

/**
 * Generate markdown wiki page file with Table documentation.
 */
class TablePageStep extends FileOutputStep {

    Table table

    @Override
    File getFile() {
        return WikiHelper.getWikiPageFile(table)
    }

    @Override
    String getCharset() {
        'utf-8'
    }

    @Override
    public String getCode() {
        """\
+++
    title= "${table.getClass().getName().substring(table.getClass().getPackage().getName().length()+1)}"
    packages=["${table.getClass().getPackage().getName().replace('.','/')}"]
    schemas=["${table.getSchema()}"]    
    types=["Table"]
    ${table.pattern ? "patterns=[\"${table.pattern.class.simpleName}\"]" : ''}
    ${table.physicalSchema ? "physical-schemas=[\"${table.getPhysicalSchema()}\"]" : ''}
    ${!table.tags.isEmpty() ? "tags=[${table.tags.collect({"\"${it}\""}).join(',')}]": ''}    
+++
${WikiHelper.renderElementDescription(table)}


${WikiHelper.renderDataModel(table)}

Columns

${table.columns.collect({"""\n"""}).join()}

Name Data type Decription
$it.name $it.dataType ${WikiHelper.renderColumnDescription(it.description)}

${WikiHelper.renderDataLineage(table)}
"""	}

}