---
name: "Plucene::Document::Field"
section: "3pm"
platform: "linux"
package: "libplucene-perl"
version: "1.25-5"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Plucene::Document::Field"
---

# Plucene::Document::Field(3pm)

A field in a Plucene::Document

## NAME

Plucene::Document::Field - A field in a Plucene::Document

## SYNOPSIS

```
        my $field = Plucene::Document::Field->Keyword($name, $string);
        my $field = Plucene::Document::Field->Text($name, $string);
        my $field = Plucene::Document::Field->UnIndexded($name, $string);
        my $field = Plucene::Document::Field->UnStored($name, $string);
```

## DESCRIPTION

Each Plucene::Document is made up of Plucene::Document::Field objects. Each of these fields can be stored, indexed or tokenised.

## FIELDS

### name

Returns the name of the field.

### string

Returns the value of the field.

### is\_stored

Returns true if the field is or will be stored, or false if it was created with `"UnStored"`.

### is\_indexed

Returns true if the field is or will be indexed, or false if it was created with `"UnIndexed"`.

### is\_tokenized

Returns true if the field is or will be tokenized, or false if it was created with `"UnIndexed"` or `"Keyword"`.

## METHODS

### Keyword

```
        my $field = Plucene::Document::Field->Keyword($name, $string);
```

This will make a new Plucene::Document::Field object that is stored  and indexed, but not tokenised.

### UnIndexed

```
        my $field = Plucene::Document::Field->UnIndexded($name, $string);
```

This will make a new Plucene::Document::Field object that is stored, but  not indexed or tokenised.

### Text

```
        my $field = Plucene::Document::Field->Text($name, $string);
```

This will make a new Plucene::Document::Field object that is stored, indexed and tokenised.

### UnStored

```
        my $field = Plucene::Document::Field->UnStored($name, $string);
```

This will make a new Plucene::Document::Field object that isn't stored, but is indexed and tokenised.