PhotoItem

java.lang.Object
- ohos.data.search.model.IndexData
- - ohos.data.search.schema.Schema<PhotoItem>
  - - ohos.data.search.schema.PhotoItem

```
public final class PhotoItem
extends Schema<PhotoItem>
```
Represents the index schema for photo items.
This schema is used to create indexes for photo items. It supports index fields size, height, width, photoCategory, shootingMode, shooting location (represented by country, province, city, district, road, latitude, and longitute), shootingDate, tag, feature, ocrText, holiday, and all the fields in CommonItem. Among these fields, identifier is mandatory and can be set via the CommonItem#setIdentifier(String) method.

从以下版本开始:

5

SystemCapability

SystemCapability.Data#DATA_SEARCH

字段概要

字段
限定符和类型	字段	说明
`static String`	`CITY`	Indicates the index field name of `city`.
`static String`	`COUNTRY`	Indicates the index field name of `country`.
`static String`	`DISTRICT`	Indicates the index field name of `district`.
`static String`	`FEATURE`	Indicates the index field name of `feature`.
`static String`	`HEIGHT`	Indicates the index field name of `height`.
`static String`	`HOLIDAY`	Indicates the index field name of `holiday`.
`static String`	`LATITUDE`	Indicates the index field name of `latitude`.
`static String`	`LONGITUDE`	Indicates the index field name of `longitude`.
`static String`	`OCR_TEXT`	Indicates the index field name of `ocrText`.
`static String`	`PHOTO_CATEGORY`	Indicates the index field name of `photoCategory`.
`static String`	`PROVINCE`	Indicates the index field name of `province`.
`static String`	`ROAD`	Indicates the index field name of `road`.
`static String`	`SHOOTING_DATE`	Indicates the index field name of `shootingDate`.
`static String`	`SHOOTING_MODE`	Indicates the index field name of `shootingMode`.
`static String`	`SIZE`	Indicates the index field name of `size`.
`static String`	`TAG`	Indicates the index field name of `tag`.
`static String`	`WIDTH`	Indicates the index field name of `width`.

构造器概要

构造器
构造器说明

PhotoItem()
A constructor used to create a PhotoItem instance.

构造器
构造器	说明
`PhotoItem()`	A constructor used to create a `PhotoItem` instance.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`String`	`getCity()`	Obtains the city where the photo is taken.
`String`	`getCountry()`	Obtains the country/region where the photo is taken.
`String`	`getDistrict()`	Obtains the city district where the photo is taken.
`String`	`getFeature()`	Obtains the feature of the photo.
`Integer`	`getHeight()`	Obtains the height of the photo.
`String`	`getHoliday()`	Obtains the holiday information about the photo.
`Double`	`getLatitude()`	Obtains the latitude of the shooting location.
`Double`	`getLongitude()`	Obtains the longitude of the shooting location.
`String`	`getOcrText()`	Obtains the text recognized within the photo.
`String`	`getPhotoCategory()`	Obtains the format (such as JPG) of the photo.
`static List<IndexForm>`	`getPhotoSchema()`	Obtains a list of index field attributes in this `PhotoItem` object.
`String`	`getProvince()`	Obtains the first-level administrative division (such as a province or state) where the photo is taken.
`String`	`getRoad()`	Obtains the road where the photo is taken.
`String`	`getShootingDate()`	Obtains the time when the photo is taken.
`String`	`getShootingMode()`	Obtains the shooting mode.
`Integer`	`getSize()`	Obtains the size of the photo.
`String`	`getTag()`	Obtains the tag of the photo.
`Integer`	`getWidth()`	Obtains the width of the photo.
`PhotoItem`	`setCity(String city)`	Sets the `city` index field.
`PhotoItem`	`setCountry(String country)`	Sets the `country` index field.
`PhotoItem`	`setDistrict(String district)`	Sets the `district` index field.
`PhotoItem`	`setFeature(String feature)`	Sets the `feature` index field.
`PhotoItem`	`setHeight(Integer height)`	Sets the `height` index field.
`PhotoItem`	`setHoliday(String holiday)`	Sets the `holiday` index field.
`PhotoItem`	`setLatitude(Double latitude)`	Sets the `latitude` index field.
`PhotoItem`	`setLongitude(Double longitude)`	Sets the `longitude` index field.
`PhotoItem`	`setOcrText(String ocrText)`	Sets the `ocrText` index field.
`PhotoItem`	`setPhotoCategory(String photoCategory)`	Sets the `photoCategory` index field.
`PhotoItem`	`setProvince(String province)`	Sets the `province` index field.
`PhotoItem`	`setRoad(String road)`	Sets the `road` index field.
`PhotoItem`	`setShootingDate(String shootingDate)`	Sets the `shootingDate` index field.
`PhotoItem`	`setShootingMode(String shootingMode)`	Sets the `shootingMode` index field.
`PhotoItem`	`setSize(Integer size)`	Sets the `size` index field.
`PhotoItem`	`setTag(String tag)`	Sets the `tag` index field.
`PhotoItem`	`setWidth(Integer width)`	Sets the `width` index field.

从类继承的方法 ohos.data.search.model.IndexData
clear, get, getAsDouble, getAsFloat, getAsInteger, getAsLong, getAsString, getValues, isEmpty, put, put, put, put, put, remove, setValues, size

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从类继承的方法 ohos.data.search.schema.Schema
getAlternateName, getCategory, getDateCreate, getDescription, getIdentifier, getKeywords, getName, getPotentialAction, getReserved1, getReserved2, getSubtitle, getThumbnailUrl, getTitle, getUrl, setAlternateName, setCategory, setDateCreate, setDescription, setIdentifier, setKeywords, setName, setPotentialAction, setReserved1, setReserved2, setSubtitle, setThumbnailUrl, setTitle, setUrl

- 字段详细资料
  - CITY
```
public static final String CITY
```
    Indicates the index field name of city.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - COUNTRY
```
public static final String COUNTRY
```
    Indicates the index field name of country.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - DISTRICT
```
public static final String DISTRICT
```
    Indicates the index field name of district.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - FEATURE
```
public static final String FEATURE
```
    Indicates the index field name of feature.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - HEIGHT
```
public static final String HEIGHT
```
    Indicates the index field name of height.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - HOLIDAY
```
public static final String HOLIDAY
```
    Indicates the index field name of holiday.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - LATITUDE
```
public static final String LATITUDE
```
    Indicates the index field name of latitude.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - LONGITUDE
```
public static final String LONGITUDE
```
    Indicates the index field name of longitude.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - OCR_TEXT
```
public static final String OCR_TEXT
```
    Indicates the index field name of ocrText.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - PHOTO_CATEGORY
```
public static final String PHOTO_CATEGORY
```
    Indicates the index field name of photoCategory.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - PROVINCE
```
public static final String PROVINCE
```
    Indicates the index field name of province.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - ROAD
```
public static final String ROAD
```
    Indicates the index field name of road.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - SHOOTING_DATE
```
public static final String SHOOTING_DATE
```
    Indicates the index field name of shootingDate.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - SHOOTING_MODE
```
public static final String SHOOTING_MODE
```
    Indicates the index field name of shootingMode.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - SIZE
```
public static final String SIZE
```
    Indicates the index field name of size.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - TAG
```
public static final String TAG
```
    Indicates the index field name of tag.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - WIDTH
```
public static final String WIDTH
```
    Indicates the index field name of width.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - PhotoItem
```
public PhotoItem()
```
    A constructor used to create a PhotoItem instance.
    
    从以下版本开始:
    
    5
- 方法详细资料
  - getPhotoSchema
```
public static List<IndexForm> getPhotoSchema()
```
    Obtains a list of index field attributes in this PhotoItem object.
    
    返回:
    
    Returns a list of index field attributes.
    
    从以下版本开始:
    
    5
  - setPhotoCategory
```
public PhotoItem setPhotoCategory(String photoCategory)
```
    Sets the photoCategory index field.
    Attributes of this index field: IndexForm.indexFieldName = "photoCategory"; IndexForm.indexType = IndexType.SORTED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;
    
    参数:
    
    photoCategory - Indicates the format (such as JPG) to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - setOcrText
```
public PhotoItem setOcrText(String ocrText)
```
    Sets the ocrText index field.
    Attributes of this index field: IndexForm.indexFieldName = "ocrText"; IndexForm.indexType = IndexType.ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = false; IndexForm.isSearch = true;
    
    参数:
    
    ocrText - Indicates recognized text to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - setHoliday
```
public PhotoItem setHoliday(String holiday)
```
    Sets the holiday index field.
    Attributes of this index field: IndexForm.indexFieldName = "holiday"; IndexForm.indexType = IndexType.SORTED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;
    
    参数:
    
    holiday - Indicates the holiday information to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - setTag
```
public PhotoItem setTag(String tag)
```
    Sets the tag index field.
    Attributes of this index field: IndexForm.indexFieldName = "tag"; IndexForm.indexType = IndexType.SORTED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;
    
    参数:
    
    tag - Indicates the tag to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - setFeature
```
public PhotoItem setFeature(String feature)
```
    Sets the feature index field.
    Attributes of this index field: IndexForm.indexFieldName = "feature"; IndexForm.indexType = IndexType.SORTED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;
    
    参数:
    
    feature - Indicates the feature to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - setShootingDate
```
public PhotoItem setShootingDate(String shootingDate)
```
    Sets the shootingDate index field.
    Attributes of this index field: IndexForm.indexFieldName = "shootingDate"; IndexForm.indexType = IndexType.SORTED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;
    
    参数:
    
    shootingDate - Indicates the shooting time to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - setShootingMode
```
public PhotoItem setShootingMode(String shootingMode)
```
    Sets the shootingMode index field.
    Attributes of this index field: IndexForm.indexFieldName = "shootingMode"; IndexForm.indexType = IndexType.SORTED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;
    
    参数:
    
    shootingMode - Indicates the shooting mode to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - setLongitude
```
public PhotoItem setLongitude(Double longitude)
```
    Sets the longitude index field.
    Attributes of this index field: IndexForm.indexFieldName = "longitude"; IndexForm.indexType = IndexType.DOUBLE; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = false;
    
    参数:
    
    longitude - Indicates the longitude to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - setLatitude
```
public PhotoItem setLatitude(Double latitude)
```
    Sets the latitude index field.
    Attributes of this index field: IndexForm.indexFieldName = "latitude"; IndexForm.indexType = IndexType.DOUBLE; IndexForm.isPrimaryKey = false;PhotoItem IndexForm.isStore = trPhotoItemue; IndexForm.isSearch = false;
    
    参数:
    
    latitude - Indicates the latitude to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - setCountry
```
public PhotoItem setCountry(String country)
```
    Sets the country index field.
    Attributes of this index field: IndexForm.indexFieldName = "country"; IndexForm.indexType = IndexType.SORTED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;
    
    参数:
    
    country - Indicates the country/region to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - setProvince
```
public PhotoItem setProvince(String province)
```
    Sets the province index field.
    Attributes of this index field: IndexForm.indexFieldName = "province"; IndexForm.indexType = IndexType.SORTED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;
    
    参数:
    
    province - Indicates the first-level administrative division (such as a province or state) to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - setCity
```
public PhotoItem setCity(String city)
```
    Sets the city index field.
    Attributes of this index field: IndexForm.indexFieldName = "city"; IndexForm.indexType = IndexType.SORTED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;
    
    参数:
    
    city - Indicates the city to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - setDistrict
```
public PhotoItem setDistrict(String district)
```
    Sets the district index field.
    Attributes of this index field: IndexForm.indexFieldName = "district"; IndexForm.indexType = IndexType.SORTED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;
    
    参数:
    
    district - Indicates the city district to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - setRoad
```
public PhotoItem setRoad(String road)
```
    Sets the road index field.
    Attributes of this index field: IndexForm.indexFieldName = "road"; IndexForm.indexType = IndexType.ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;
    
    参数:
    
    road - Indicates the road to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - setSize
```
public PhotoItem setSize(Integer size)
```
    Sets the size index field.
    Attributes of this index field: IndexForm.indexFieldName = "size"; IndexForm.indexType = IndexType.NO; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = false;
    
    参数:
    
    size - Indicates the size to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - setHeight
```
public PhotoItem setHeight(Integer height)
```
    Sets the height index field.
    Attributes of this index field: IndexForm.indexFieldName = "height"; IndexForm.indexType = IndexType.NO; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = false;
    
    参数:
    
    height - Indicates the height to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - setWidth
```
public PhotoItem setWidth(Integer width)
```
    Sets the width index field.
    Attributes of this index field: IndexForm.indexFieldName = "width"; IndexForm.indexType = IndexType.NO; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = false;
    
    参数:
    
    width - Indicates the width to set.
    
    返回:
    
    Returns this PhotoItem object.
    
    从以下版本开始:
    
    5
  - getPhotoCategory
```
public String getPhotoCategory()
```
    Obtains the format (such as JPG) of the photo.
    
    返回:
    
    Returns the format.
    
    从以下版本开始:
    
    5
  - getOcrText
```
public String getOcrText()
```
    Obtains the text recognized within the photo.
    
    返回:
    
    Returns text recognized within the photo.
    
    从以下版本开始:
    
    5
  - getHoliday
```
public String getHoliday()
```
    Obtains the holiday information about the photo.
    
    返回:
    
    Returns the holiday information.
    
    从以下版本开始:
    
    5
  - getTag
```
public String getTag()
```
    Obtains the tag of the photo.
    
    返回:
    
    Returns the tag of the photo.
    
    从以下版本开始:
    
    5
  - getFeature
```
public String getFeature()
```
    Obtains the feature of the photo.
    
    返回:
    
    Returns the feature.
    
    从以下版本开始:
    
    5
  - getShootingDate
```
public String getShootingDate()
```
    Obtains the time when the photo is taken.
    
    返回:
    
    Returns the time when the photo is taken.
    
    从以下版本开始:
    
    5
  - getShootingMode
```
public String getShootingMode()
```
    Obtains the shooting mode.
    
    返回:
    
    Returns the shooting mode.
    
    从以下版本开始:
    
    5
  - getLatitude
```
public Double getLatitude()
```
    Obtains the latitude of the shooting location.
    
    返回:
    
    Returns the latitude.
    
    从以下版本开始:
    
    5
  - getLongitude
```
public Double getLongitude()
```
    Obtains the longitude of the shooting location.
    
    返回:
    
    Returns the longitude.
    
    从以下版本开始:
    
    5
  - getCountry
```
public String getCountry()
```
    Obtains the country/region where the photo is taken.
    
    返回:
    
    Returns the country/region.
    
    从以下版本开始:
    
    5
  - getProvince
```
public String getProvince()
```
    Obtains the first-level administrative division (such as a province or state) where the photo is taken.
    
    返回:
    
    Returns the first-level administrative division.
    
    从以下版本开始:
    
    5
  - getCity
```
public String getCity()
```
    Obtains the city where the photo is taken.
    
    返回:
    
    Returns the city.
    
    从以下版本开始:
    
    5
  - getDistrict
```
public String getDistrict()
```
    Obtains the city district where the photo is taken.
    
    返回:
    
    Returns the city district.
    
    从以下版本开始:
    
    5
  - getRoad
```
public String getRoad()
```
    Obtains the road where the photo is taken.
    
    返回:
    
    Returns the road.
    
    从以下版本开始:
    
    5
  - getSize
```
public Integer getSize()
```
    Obtains the size of the photo.
    
    返回:
    
    Returns the size of the photo.
    
    从以下版本开始:
    
    5
  - getHeight
```
public Integer getHeight()
```
    Obtains the height of the photo.
    
    返回:
    
    Returns the height.
    
    从以下版本开始:
    
    5
  - getWidth
```
public Integer getWidth()
```
    Obtains the width of the photo.
    
    返回:
    
    Returns the width of the photo.
    
    从以下版本开始:
    
    5

类 PhotoItem

字段概要

构造器概要

方法概要

从类继承的方法 ohos.data.search.model.IndexData

从类继承的方法 java.lang.Object

从类继承的方法 ohos.data.search.schema.Schema

字段详细资料

CITY

COUNTRY

DISTRICT

FEATURE

HEIGHT

HOLIDAY

LATITUDE

LONGITUDE

OCR_TEXT

PHOTO_CATEGORY

PROVINCE

ROAD

SHOOTING_DATE

SHOOTING_MODE

SIZE

TAG

WIDTH

构造器详细资料

PhotoItem

方法详细资料

getPhotoSchema

setPhotoCategory

setOcrText

setHoliday

setTag

setFeature

setShootingDate

setShootingMode

setLongitude

setLatitude

setCountry

setProvince

setCity

setDistrict

setRoad

setSize

setHeight

setWidth

getPhotoCategory

getOcrText

getHoliday

getTag

getFeature

getShootingDate

getShootingMode

getLatitude

getLongitude

getCountry

getProvince

getCity

getDistrict

getRoad

getSize

getHeight

getWidth