模块fmeobjects::类FMEUniversalReader
(隐藏私人]
()|没有框架]

类FMEUniversalReader


init (readerName cacheFeatures指令)

创建一个FME读取器来从格式或系统中读取数据。只需要传入FME参考手册第二部分中找到的阅读器的mneumonic类型。读取器所需的任何参数都将通过它的“open”调用传递给它。

实例方法 (隐藏私人]
__init__(readerName,cacheFeatures,指令)
x.__init__ x(…)初始化;有关签名,请参见帮助(键入(x))
一个新对象,类型为S,子类型为T
__new__(T,年代,)
没有一个
中止()
中途终止阅读器。
没有一个
关闭()
在耗尽其数据源之后关闭阅读器。
没有一个
flushCachedGeometries()
此方法将缓存的几何图形刷新到磁盘。
dict
getNativeProperties(propertyCategory)
查询本机阅读器以获得属性。
dict
getproperty(propertyCategory)
返回给定属性类别的属性值。
没有一个
开放(datasetName,参数)
读者开放。
FMEFeature
()
返回数据源中的下一个特性。
FMEFeature
readSchema()
返回数据源的下一个模式特性。
没有一个
setConstraints(功能)
指定读取数据时使用的空间和属性约束。
没有一个
setSchema(功能)
从模式特性中提取读取器参数并在此读取器上设置参数。

继承自对象:__delattr__,__format__,__getattribute__,__hash__,__reduce__,__reduce_ex__,__repr__,__setattr__,__sizeof__,__str__,__subclasshook__

属性 (隐藏私人]

继承自对象:__class__进行

方法详细信息 (隐藏私人]

__init__(readerName,cacheFeatures,指令)
(构造函数)

x.__init__ x(…)初始化;有关签名,请参见帮助(键入(x))

参数:
  • readerName(字符串)
  • cacheFeatures(bool)- - -如果真正的然后,读取器构建一个空间索引并缓存特性,从而使后续读取更快。只有将真正的当需要多次读取输入数据时。设置为如果源数据集中的每个特性只读取一次。
  • 指令(dict列表字符串s) -为读者指定一个或多个附加指令。此集合中的所有元素都必须是字符串年代。如果要将一个键设置为多个值,则应该使用列表。如果传入一个列表,则键-值对,如a中的键-值对Dict必须并排放置。例如,键应该放在第一个列表元素中,然后是键的值。

    受支持的指令有:

    'USER_PIPELINE'这个指令接受一个管道文件名作为它的值。如果不是完整路径名,则管道文件必须位于FME安装下的userPipeline目录中。如果是绝对路径名,则打开并使用该位置的管道文件。指定此指令将导致阅读器的所有特性在提供给应用程序之前首先通过用户管道。'RUNTIME_MACROS'这个指令接受一个系统数据格式(SDF)的宏名称和值列表——有关说明,请参阅fmedlg.h。该指令提供了一种方便的方法,可以将设置从对话框包传播到正在创建的读取器。这些设置控制阅读器本身的行为。这个指令接受一个系统数据格式(SDF)的宏名称和值的列表——查看fmedlg.h的描述。该指令提供了一种方便的方法,可以将设置从对话框包传播到正在创建的读取器。这些设置通常控制读者的元文件和模式信息的行为。'元文件'这个指令采用的元文件的名称,应该用于本读者。这是在对话框包的元文件参数中返回的。有时候,设置框可能会请求使用一个特定的元文件来控制阅读器的行为。这个指令提供了一种将信息传播给读者的方法。“COORDSYS”这个指令接受所有功能都应该转换成的坐标系统的名称(如果读者认为它们来自不同的坐标系统),或者加上标签。该值是任何有效的FME坐标系统名称。这允许调用者指定应该返回特性的坐标系统。'IDLIST'这个指令接受一个SDF格式的' id '列表,它将限制阅读器正在读取的表。这允许调用者限制将被读入的表。例如,该列表可能包含应该从目录中读取的形状文件的基名称。这个指令接受一个未解析的字符串,其中包含一个完整的DEF行,以添加到任何其他将被使用。(该值不应该包含第一个'KEYWORD_DEF'令牌。)This allows the caller to specify DEF lines that the reader should use in conjunction with any others that may be automatically read from the 'metafiles/KEYWORD_reader_def.fmi' file.'OUTPUT_STATS'这个指令的值是或否。如果没有,则不会将写入者统计信息输出到日志文件。默认是YES。这允许调用者关闭一些通常由写入者执行的统计日志记录。'SCHEMA_FORMAT_ATTRIBUTES'这个指令的值是或否。如果是,那么对阅读器的任何readSchema调用都将包含返回的模式特性上的阅读器的格式属性。默认是NO。”,
                
                 任何以两个破折号开头的指令都被认为是一个宏名,将被设置为供读者使用的固定DEF文件(
                 
                  _reader_def.fmi)。例如,如果指令名‘——MySetting’的值是‘Yes’,那么宏‘MySetting’的值就是‘Yes’,用于DEF文件。
                 
                
覆盖:object.__init__

__new__(T,年代,)

返回:一个类型为S的新对象,子类型为T
覆盖:object.__new__

中止()

中途终止阅读器。

返回: 没有一个
提出了:
  • FMEException-如果出现错误,将引发FMEException。

关闭()

在耗尽其数据源之后关闭阅读器。

返回: 没有一个
提出了:
  • FMEException-如果出现错误,将引发FMEException。

flushCachedGeometries()

此方法将缓存的几何图形刷新到磁盘。在读取和构建特性缓存时,大多数几何图形都将保存在内存中,以避免序列化它们的开销。调用此方法将强制将未序列化的几何图形写入磁盘。通常不需要进行此调用。但是,在直接访问临时缓存的ffs文件时,它可能很有用。

返回: 没有一个
提出了:
  • FMEException-如果出现错误,将引发FMEException。

getNativeProperties(propertyCategory)

查询本机阅读器以获得属性。它是pluginbuilder.FMEUniversalReader.getProperties()方法的代理。有关更多信息,请参考FME Plugin Builder SDK中Plugin . fmeuniversalreader . getproperties()的文档。

参数:
  • propertyCategory(字符串)
返回: dict
没有一个如果属性类别不被识别,则返回。

getproperty(propertyCategory)

返回给定属性类别的属性值。

此方法处理下列属性类别:

“fme_prop_spatial_index”

返回值将包含键'fme_prop_spatial_index',其中的'FME_TRUE'或'FME_FALSE'指示正在使用的读取器是否已启用了spatially。没有一个如果读取器不知道正确的值,则返回。

“fme_prop_persistent_cache_loaded”

返回值将包含键'fme_prop_persistent_cache_loaded',其中的'FME_TRUE'或'FME_FALSE'指示是否加载了读取器持久缓存。没有一个如果读取器不知道正确的值,则返回。

“fme_prop_coord_sys_aware”

返回值将包含键'fme_prop_coord_sys_aware',其中'FME_TRUE'或'FME_FALSE'指示阅读器是否识别坐标系统。没有一个如果读取器不知道正确的值,则返回。

‘*’

返回所有已知属性类别的所有属性。

参数:
  • propertyCategory(字符串)
返回: dict
没有一个如果属性类别不被识别,则返回。

开放(datasetName,参数)

读者开放。

参数:
  • datasetName(字符串) -数据集的名称。
  • 参数(列表字符串s) -参数列表。
返回: 没有一个
提出了:
  • FMEException-如果出现错误,将引发FMEException。

()

返回数据源中的下一个特性。

返回: FMEFeature
返回 没有一个如果数据源已耗尽。
提出了:
  • FMEException-如果出现错误,将引发FMEException。

readSchema()

返回数据源的下一个模式特性。

返回: FMEFeature
返回 没有一个如果所有模式特性都已返回。
提出了:
  • FMEException-如果出现错误,将引发FMEException。

setConstraints(功能)

指定读取数据时使用的空间和属性约束。空间和属性查询在feature对象中指定。这只需要由那些将spatialenable()返回为true的读取器实现,否则它们什么也做不了。可以在创建读取器之后的任何时候调用它。如果任何读操作正在进行中,那么它将被终止,下一次读操作将反映新的约束。

约束特性必须有一个名为'fme_search_type'的属性。此属性的值指示要执行的搜索类型。支持的值是:

“fme_envelope_intersects”

当这是值时,则使用特性的包围框作为查询信封。将来对数据的读取将只返回信封区域中的那些特性。

“fme_closest”

当该值为时,将来的读操作将只返回最接近传递的特性的边界框中心的单个特性。通常使用点特征。此外,使用此搜索方法时,必须在附加的'fme_max_distance'属性中给出最大距离。

“fme_specified_feature”

当这是值时,以后的读取将只返回由附加的'fme_index'属性指定的单个特性,该属性以非负整数为值,即从0开始的整数。如果索引超出范围,则在随后的read()调用时不会返回任何特性。最好在设置此约束之前加载特性缓存,如果未加载缓存,则读取器将自动将指定数据集中的所有特性读取到缓存中。要手动加载特性缓存,只需使用read()方法读取所有特性,直到read()方法标志返回FME_TRUE。

参数:
返回: 没有一个
提出了:
  • FMEException-如果出现错误,将引发FMEException。

setSchema(功能)

从模式特性中提取读取器参数并在此读取器上设置参数。

参数:
返回: 没有一个
提出了:
  • FMEException-如果出现错误,将引发FMEException。