contentbox.model.exporters

Class FileExporter

railo-context.Component
        extended by contentbox.model.exporters.FileExporter
Class Attributes:
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    All Implemented Interfaces:
    ICBExporter

    ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Exporter for file-based content

    Property Summary
    type property default serializable required
    string directory


    true false
    string displayName


    true false
    string extension


    true false
    string fileName


    true false
    string format


    true false
    string includeFiles


    true false
    any log


    • inject = logbox:logger:{this}
    true false
    numeric priority


    true false
    string type


    true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    string getDirectory()
    string getDisplayName()
    string getExtension()
    string getFileList()
         Gets list of files (absolute paths) when not "all" options are chosen for export.
    string getFileName()
    string getFormat()
    string getIncludeFiles()
    string getLog()
    string getName()
         Gets the name of the exporter.
    string getPriority()
    numeric getTotal()
         Gets "total" based on content type.
    string getType()
    boolean isValid()
         Determines if exporter is valid based on validation criteria.
    any setDirectory(string directory)
    any setDisplayName(string displayName)
    any setExtension(string extension)
    any setFileName(string fileName)
    any setFormat(string format)
    any setIncludeFiles(string includeFiles)
    any setLog(any log)
    any setPriority(numeric priority)
    any setType(string type)
    array validate()
         Custom validator for this exporter.
     
    Methods inherited from class railo-context.Component
    None

    Constructor Detail

    init

    public init()

    Constructor


    Property Detail

    directory

    property string directory

    Attributes:
    required - false
    serializable - true

    displayName

    property string displayName

    Attributes:
    required - false
    serializable - true

    extension

    property string extension

    Attributes:
    required - false
    serializable - true

    fileName

    property string fileName

    Attributes:
    required - false
    serializable - true

    format

    property string format

    Attributes:
    required - false
    serializable - true

    includeFiles

    property string includeFiles

    Attributes:
    required - false
    serializable - true

    log

    property any log

    Attributes:
    required - false
    inject - logbox:logger:{this}
    serializable - true

    priority

    property numeric priority

    Attributes:
    required - false
    serializable - true

    type

    property string type

    Attributes:
    required - false
    serializable - true

    Method Detail

    getDirectory

    public string getDirectory()


    getDisplayName

    public string getDisplayName()


    getExtension

    public string getExtension()


    getFileList

    public string getFileList()

    Gets list of files (absolute paths) when not "all" options are chosen for export


    getFileName

    public string getFileName()


    getFormat

    public string getFormat()


    getIncludeFiles

    public string getIncludeFiles()


    getLog

    public string getLog()


    getName

    public string getName()

    Gets the name of the exporter

    Specified by:
    getName in interface ICBExporter

    getPriority

    public string getPriority()


    getTotal

    public numeric getTotal()

    Gets "total" based on content type

    Specified by:
    getTotal in interface ICBExporter

    getType

    public string getType()


    isValid

    public boolean isValid()

    Determines if exporter is valid based on validation criteria

    Specified by:
    isValid in interface ICBExporter

    setDirectory

    public any setDirectory(string directory)

    Parameters:
    directory

    setDisplayName

    public any setDisplayName(string displayName)

    Parameters:
    displayName

    setExtension

    public any setExtension(string extension)

    Parameters:
    extension

    setFileName

    public any setFileName(string fileName)

    Parameters:
    fileName

    setFormat

    public any setFormat(string format)

    Parameters:
    format

    setIncludeFiles

    public any setIncludeFiles(string includeFiles)

    Parameters:
    includeFiles

    setLog

    public any setLog(any log)

    Parameters:
    log

    setPriority

    public any setPriority(numeric priority)

    Parameters:
    priority

    setType

    public any setType(string type)

    Parameters:
    type

    validate

    public array validate()

    Custom validator for this exporter...any rules can be applied

    Specified by:
    validate in interface ICBExporter