#include <ImportDescriptor.h>
Public Member Functions | |
| virtual void | setDataDescriptor (DataDescriptor *pDescriptor)=0 |
| virtual DataDescriptor * | getDataDescriptor () const =0 |
| virtual void | setImported (bool bImport)=0 |
| virtual bool | isImported () const =0 |
Protected Member Functions | |
| virtual | ~ImportDescriptor () |
The import descriptor contains all parameters necessary to import a single DataElement, including a DataDescriptor and a flag that specifies whether the data should be included or ignored on import.
Importers should create an import descriptor by calling ModelServices::createImportDescriptor() from within the Importer::getImportDescriptors() method.
Definition at line 28 of file ImportDescriptor.h.
| virtual ImportDescriptor::~ImportDescriptor | ( | ) | [protected, virtual] |
This object should be destroyed by calling ModelServices::destroyImportDescriptor().
Definition at line 91 of file ImportDescriptor.h.
| virtual void ImportDescriptor::setDataDescriptor | ( | DataDescriptor * | pDescriptor | ) | [pure virtual] |
Sets the data set to import.
This method sets a new underlying data descriptor for import and deletes the previous data descriptor. The import descriptor assumes ownership of the given data descriptor and will delete it when the import descriptor is destroyed or on the next call to setDataDescriptor().
| pDescriptor | The data descriptor to import. Ownership is transferred to the import descriptor. |
| virtual DataDescriptor* ImportDescriptor::getDataDescriptor | ( | ) | const [pure virtual] |
Returns the data set for import.
| virtual void ImportDescriptor::setImported | ( | bool | bImport | ) | [pure virtual] |
Sets whether the data element represented by the underlying data descriptor should be imported.
This method provides a means by which the underlying data descriptor can be ignored on import. Importers can call this method to default the data to load on import or to ignore loading the data on import. In interactive mode the application will call this method to set the value based the user selects in the import dialog.
By default when an ImportDescriptor is created, the import flag is set to true.
| bImport | Set this value to true to import the given data element or to false to ignore the data element when importing. |
| virtual bool ImportDescriptor::isImported | ( | ) | const [pure virtual] |
Queries whether the data element represented by the underlying data descriptor should be imported.
By default when an ImportDescriptor is created, this method returns true.
true if the data represented by the underlying data descriptor should be imported, or false if the data should be ignored on import.