ContentBox Core API 1.6.0

contentbox.model.exporters
Class FileExporter

WEB-INF.cftags.component
        extended by contentbox.model.exporters.FileExporter
All Implemented Interfaces:
ICBExporter

public class FileExporter
extends WEB-INF.cftags.component

******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | 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 & Description Default Serializable Required
 string directory


Attributes:
true false
 string displayName


Attributes:
true false
 string extension


Attributes:
true false
 string fileName


Attributes:
true false
 string format


Attributes:
true false
 string includeFiles


Attributes:
true false
 any log


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


Attributes:
true false
 string type


Attributes:
true false
 
Constructor Summary
init()
          Constructor
 
Method Summary
 string GETDIRECTORY()
 string GETDISPLAYNAME()
 string GETEXTENSION()
 string GETFILENAME()
 string GETFORMAT()
 string GETINCLUDEFILES()
 any GETLOG()
 numeric GETPRIORITY()
 string GETTYPE()
 FileExporter SETDIRECTORY(string directory)
 FileExporter SETDISPLAYNAME(string displayName)
 FileExporter SETEXTENSION(string extension)
 FileExporter SETFILENAME(string fileName)
 FileExporter SETFORMAT(string format)
 FileExporter SETINCLUDEFILES(string includeFiles)
 FileExporter SETLOG(any log)
 FileExporter SETPRIORITY(numeric priority)
 FileExporter SETTYPE(string type)
 string getFileList()
          Gets list of files (absolute paths) when not "all" options are chosen for export
 string getName()
          Gets the name of the exporter
 numeric getTotal()
          Gets "total" based on content type
 boolean isValid()
          Determines if exporter is valid based on validation criteria
 array validate()
          Custom validator for this exporter
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init()
Constructor

Property Detail

directory

string directory

Attributes:
default -
serializable - true
required - false

displayName

string displayName

Attributes:
default -
serializable - true
required - false

extension

string extension

Attributes:
default -
serializable - true
required - false

fileName

string fileName

Attributes:
default -
serializable - true
required - false

format

string format

Attributes:
default -
serializable - true
required - false

includeFiles

string includeFiles

Attributes:
default -
serializable - true
required - false

log

any log

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

priority

numeric priority

Attributes:
default -
serializable - true
required - false

type

string type

Attributes:
default -
serializable - true
required - false

Method Detail

GETDIRECTORY

public string GETDIRECTORY()


GETDISPLAYNAME

public string GETDISPLAYNAME()


GETEXTENSION

public string GETEXTENSION()


GETFILENAME

public string GETFILENAME()


GETFORMAT

public string GETFORMAT()


GETINCLUDEFILES

public string GETINCLUDEFILES()


GETLOG

public any GETLOG()


GETPRIORITY

public numeric GETPRIORITY()


GETTYPE

public string GETTYPE()


SETDIRECTORY

public FileExporter SETDIRECTORY(string directory)

Parameters:
directory

SETDISPLAYNAME

public FileExporter SETDISPLAYNAME(string displayName)

Parameters:
displayName

SETEXTENSION

public FileExporter SETEXTENSION(string extension)

Parameters:
extension

SETFILENAME

public FileExporter SETFILENAME(string fileName)

Parameters:
fileName

SETFORMAT

public FileExporter SETFORMAT(string format)

Parameters:
format

SETINCLUDEFILES

public FileExporter SETINCLUDEFILES(string includeFiles)

Parameters:
includeFiles

SETLOG

public FileExporter SETLOG(any log)

Parameters:
log

SETPRIORITY

public FileExporter SETPRIORITY(numeric priority)

Parameters:
priority

SETTYPE

public FileExporter SETTYPE(string type)

Parameters:
type

getFileList

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


getName

public string getName()
Gets the name of the exporter

Specified by:
getName in interface ICBExporter

getTotal

public numeric getTotal()
Gets "total" based on content type

Specified by:
getTotal in interface ICBExporter

isValid

public boolean isValid()
Determines if exporter is valid based on validation criteria

Specified by:
isValid in interface ICBExporter

validate

public array validate()
Custom validator for this exporter...any rules can be applied

Specified by:
validate in interface ICBExporter

ContentBox Core API 1.6.0