Created: (LUCENE-1001) Add Payload retrieval to Spans

Add Payload retrieval to Spans
------------------------------

                 Key: LUCENE-1001
                 URL: htt
ps://issues.apache.org/jira/browse/LUCENE-1001
             Project: Lucene - Java
          Issue Type: New Feature
          Components: Search
            Reporter: Grant Ingersoll
            Assignee: Grant Ingersoll
            Priority: Minor


It will be nice to have access to payloads when doing
SpanQuerys.

See http://www.gossamer-threads.com/lists/lucene/java-dev
/52270 and http://www.gossamer-threads.com/lists/lucene/java-dev
/51134

Current API, added to Spans.java is below.  I will try to
post a patch as soon as I can figure out how to make it work
for unordered spans (I believe I have all the other cases
working).


 /**
   * Returns the payload data for the current span.
   * This is invalid until {link #next()} is called
for
   * the first time.
   * This method must not be called more than once after
each call
   * of {link #next()}. However, payloads are loaded lazily,
   * so if the payload data for the current position is not
needed,
   * this method may not be called at all for performance
reasons.<br>
   * <br>
   * <p><font color="#FF0000">
   * WARNING: The status of the <b>Payloads</b>
feature is experimental.
   * The APIs introduced here might change in the future and
will not be
   * supported anymore in such a case.</font>
   *
   * return a List of byte arrays containing the data of
this payload
   * throws IOException
   */
  // TODO: Remove warning after API has been finalized
  List/*<byte[]>*/ getPayload() throws IOException;

  /**
   * Checks if a payload can be loaded at this position.
   * <p/>
   * Payloads can only be loaded once per call to
   * {link #next()}.
   * <p/>
   * <p><font color="#FF0000">
   * WARNING: The status of the <b>Payloads</b>
feature is experimental.
   * The APIs introduced here might change in the future and
will not be
   * supported anymore in such a case.</font>
   *
   * return true if there is a payload available at this
position that can be loaded
   */
  // TODO: Remove warning after API has been finalized
  public boolean isPayloadAvailable();

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue
online.


------------------------------------------------------------
---------
To unsubscribe, e-mail: java-dev-unsubscribelucene.apache.org
For additional commands, e-mail: java-dev-helplucene.apache.org

    [ https://issues.apache.org/jira/browse
/LUCENE-1001?page=com.atlassian.jira.plugin.system.issuetabp
anels:comment-tabpanel#action_12527837 ] 

Paul Elschot commented on LUCENE-1001:
--------------------------------------

Could you put this in a subclass of Spans?

A little while ago I suggested to add a score() method to
Spans to summarize the influence of subspans on the span
score, and that would be another direction for a subclass.


> Add Payload retrieval to Spans
> ------------------------------
>
>                 Key: LUCENE-1001
>                 URL: htt
ps://issues.apache.org/jira/browse/LUCENE-1001
>             Project: Lucene - Java
>          Issue Type: New Feature
>          Components: Search
>            Reporter: Grant Ingersoll
>            Assignee: Grant Ingersoll
>            Priority: Minor
>
> It will be nice to have access to payloads when doing
SpanQuerys.
> See http://www.gossamer-threads.com/lists/lucene/java-dev
/52270 and http://www.gossamer-threads.com/lists/lucene/java-dev
/51134
> Current API, added to Spans.java is below.  I will try
to post a patch as soon as I can figure out how to make it
work for unordered spans (I believe I have all the other
cases working).
>  /**
>    * Returns the payload data for the current span.
>    * This is invalid until {link #next()} is called
for
>    * the first time.
>    * This method must not be called more than once
after each call
>    * of {link #next()}. However, payloads are
loaded lazily,
>    * so if the payload data for the current position is
not needed,
>    * this method may not be called at all for
performance reasons.<br>
>    * <br>
>    * <p><font color="#FF0000">
>    * WARNING: The status of the
<b>Payloads</b> feature is experimental.
>    * The APIs introduced here might change in the
future and will not be
>    * supported anymore in such a case.</font>
>    *
>    * return a List of byte arrays containing the data of
this payload
>    * throws IOException
>    */
>   // TODO: Remove warning after API has been finalized
>   List/*<byte[]>*/ getPayload() throws
IOException;
>   /**
>    * Checks if a payload can be loaded at this
position.
>    * <p/>
>    * Payloads can only be loaded once per call to
>    * {link #next()}.
>    * <p/>
>    * <p><font color="#FF0000">
>    * WARNING: The status of the
<b>Payloads</b> feature is experimental.
>    * The APIs introduced here might change in the
future and will not be
>    * supported anymore in such a case.</font>
>    *
>    * return true if there is a payload available at this
position that can be loaded
>    */
>   // TODO: Remove warning after API has been finalized
>   public boolean isPayloadAvailable();

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue
online.


------------------------------------------------------------
---------
To unsubscribe, e-mail: java-dev-unsubscribelucene.apache.org
For additional commands, e-mail: java-dev-helplucene.apache.org

     [ https://issues.apache.org/jira/browse/LUCENE-1001?page=co
m.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Grant Ingersoll updated LUCENE-1001:
------------------------------------

    Description: 
It will be nice to have access to payloads when doing
SpanQuerys.

See http://www.gossamer-threads.com/lists/lucene/java-dev
/52270 and http://www.gossamer-threads.com/lists/lucene/java-dev
/51134

Current API, added to Spans.java is below.  I will try to
post a patch as soon as I can figure out how to make it work
for unordered spans (I believe I have all the other cases
working).


 /**
   * Returns the payload data for the current span.
   * This is invalid until {link #next()} is called
for
   * the first time.
   * This method must not be called more than once after
each call
   * of {link #next()}. However, payloads are loaded lazily,
   * so if the payload data for the current position is not
needed,
   * this method may not be called at all for performance
reasons.<br>
   * <br>
   * <p><font color="#FF0000">
   * WARNING: The status of the <b>Payloads</b>
feature is experimental.
   * The APIs introduced here might change in the future and
will not be
   * supported anymore in such a case.</font>
   *
   * return a List of byte arrays containing the data of
this payload
   * throws IOException
   */
  // TODO: Remove warning after API has been finalized
  List/*<byte[]>*/ getPayload() throws IOException;

  /**
   * Checks if a payload can be loaded at this position.
   * <p/>
   * Payloads can only be loaded once per call to
   * {link #next()}.
   * <p/>
   * <p><font color="#FF0000">
   * WARNING: The status of the <b>Payloads</b>
feature is experimental.
   * The APIs introduced here might change in the future and
will not be
   * supported anymore in such a case.</font>
   *
   * return true if there is a payload available at this
position that can be loaded
   */
  // TODO: Remove warning after API has been finalized
  public boolean isPayloadAvailable();


  was:
It will be nice to have access to payloads when doing
SpanQuerys.

See http://www.gossamer-threads.com/lists/lucene/java-dev
/52270 and http://www.gossamer-threads.com/lists/lucene/java-dev
/51134

Current API, added to Spans.java is below.  I will try to
post a patch as soon as I can figure out how to make it work
for unordered spans (I believe I have all the other cases
working).


 /**
   * Returns the payload data for the current span.
   * This is invalid until {link #next()} is called
for
   * the first time.
   * This method must not be called more than once after
each call
   * of {link #next()}. However, payloads are loaded lazily,
   * so if the payload data for the current position is not
needed,
   * this method may not be called at all for performance
reasons.<br>
   * <br>
   * <p><font color="#FF0000">
   * WARNING: The status of the <b>Payloads</b>
feature is experimental.
   * The APIs introduced here might change in the future and
will not be
   * supported anymore in such a case.</font>
   *
   * return a List of byte arrays containing the data of
this payload
   * throws IOException
   */
  // TODO: Remove warning after API has been finalized
  List/*<byte[]>*/ getPayload() throws IOException;

  /**
   * Checks if a payload can be loaded at this position.
   * <p/>
   * Payloads can only be loaded once per call to
   * {link #next()}.
   * <p/>
   * <p><font color="#FF0000">
   * WARNING: The status of the <b>Payloads</b>
feature is experimental.
   * The APIs introduced here might change in the future and
will not be
   * supported anymore in such a case.</font>
   *
   * return true if there is a payload available at this
position that can be loaded
   */
  // TODO: Remove warning after API has been finalized
  public boolean isPayloadAvailable();


> Add Payload retrieval to Spans
> ------------------------------
>
>                 Key: LUCENE-1001
>                 URL: htt
ps://issues.apache.org/jira/browse/LUCENE-1001
>             Project: Lucene - Java
>          Issue Type: New Feature
>          Components: Search
>            Reporter: Grant Ingersoll
>            Assignee: Grant Ingersoll
>            Priority: Minor
>
> It will be nice to have access to payloads when doing
SpanQuerys.
> See http://www.gossamer-threads.com/lists/lucene/java-dev
/52270 and http://www.gossamer-threads.com/lists/lucene/java-dev
/51134
> Current API, added to Spans.java is below.  I will try
to post a patch as soon as I can figure out how to make it
work for unordered spans (I believe I have all the other
cases working).
> 
>  /**
>    * Returns the payload data for the current span.
>    * This is invalid until {link #next()} is called
for
>    * the first time.
>    * This method must not be called more than once
after each call
>    * of {link #next()}. However, payloads are
loaded lazily,
>    * so if the payload data for the current position is
not needed,
>    * this method may not be called at all for
performance reasons.<br>
>    * <br>
>    * <p><font color="#FF0000">
>    * WARNING: The status of the
<b>Payloads</b> feature is experimental.
>    * The APIs introduced here might change in the
future and will not be
>    * supported anymore in such a case.</font>
>    *
>    * return a List of byte arrays containing the data of
this payload
>    * throws IOException
>    */
>   // TODO: Remove warning after API has been finalized
>   List/*<byte[]>*/ getPayload() throws
IOException;
>   /**
>    * Checks if a payload can be loaded at this
position.
>    * <p/>
>    * Payloads can only be loaded once per call to
>    * {link #next()}.
>    * <p/>
>    * <p><font color="#FF0000">
>    * WARNING: The status of the
<b>Payloads</b> feature is experimental.
>    * The APIs introduced here might change in the
future and will not be
>    * supported anymore in such a case.</font>
>    *
>    * return true if there is a payload available at this
position that can be loaded
>    */
>   // TODO: Remove warning after API has been finalized
>   public boolean isPayloadAvailable();
> 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue
online.


------------------------------------------------------------
---------
To unsubscribe, e-mail: java-dev-unsubscribelucene.apache.org
For additional commands, e-mail: java-dev-helplucene.apache.org

    [ https://issues.apache.org/jira/browse
/LUCENE-1001?page=com.atlassian.jira.plugin.system.issuetabp
anels:comment-tabpanel#action_12527855 ] 

Grant Ingersoll commented on LUCENE-1001:
-----------------------------------------

Do you mean in a separate interface?  I suppose I should for
backward compatibility so that people with existing Span
implementations outside of Lucene aren't broken.

> Add Payload retrieval to Spans
> ------------------------------
>
>                 Key: LUCENE-1001
>                 URL: htt
ps://issues.apache.org/jira/browse/LUCENE-1001
>             Project: Lucene - Java
>          Issue Type: New Feature
>          Components: Search
>            Reporter: Grant Ingersoll
>            Assignee: Grant Ingersoll
>            Priority: Minor
>
> It will be nice to have access to payloads when doing
SpanQuerys.
> See http://www.gossamer-threads.com/lists/lucene/java-dev
/52270 and http://www.gossamer-threads.com/lists/lucene/java-dev
/51134
> Current API, added to Spans.java is below.  I will try
to post a patch as soon as I can figure out how to make it
work for unordered spans (I believe I have all the other
cases working).
> 
>  /**
>    * Returns the payload data for the current span.
>    * This is invalid until {link #next()} is called
for
>    * the first time.
>    * This method must not be called more than once
after each call
>    * of {link #next()}. However, payloads are
loaded lazily,
>    * so if the payload data for the current position is
not needed,
>    * this method may not be called at all for
performance reasons.<br>
>    * <br>
>    * <p><font color="#FF0000">
>    * WARNING: The status of the
<b>Payloads</b> feature is experimental.
>    * The APIs introduced here might change in the
future and will not be
>    * supported anymore in such a case.</font>
>    *
>    * return a List of byte arrays containing the data of
this payload
>    * throws IOException
>    */
>   // TODO: Remove warning after API has been finalized
>   List/*<byte[]>*/ getPayload() throws
IOException;
>   /**
>    * Checks if a payload can be loaded at this
position.
>    * <p/>
>    * Payloads can only be loaded once per call to
>    * {link #next()}.
>    * <p/>
>    * <p><font color="#FF0000">
>    * WARNING: The status of the
<b>Payloads</b> feature is experimental.
>    * The APIs introduced here might change in the
future and will not be
>    * supported anymore in such a case.</font>
>    *
>    * return true if there is a payload available at this
position that can be loaded
>    */
>   // TODO: Remove warning after API has been finalized
>   public boolean isPayloadAvailable();
> 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue
online.


------------------------------------------------------------
---------
To unsubscribe, e-mail: java-dev-unsubscribelucene.apache.org
For additional commands, e-mail: java-dev-helplucene.apache.org

    [ https://issues.apache.org/jira/browse
/LUCENE-1001?page=com.atlassian.jira.plugin.system.issuetabp
anels:comment-tabpanel#action_12527856 ] 

Grant Ingersoll commented on LUCENE-1001:
-----------------------------------------

This also blurs the line more between payloads and Spans, I
suggest we drop the payloads package and move the
BoostingTermQuery into the Spans package.  I originally
thought there would be more distinction between the two
packages, but that seems less likely now.

Since payloads are still marked as experimental, does anyone
see a problem with moving it?  I suppose it could be
deprecated and copied since it has been released.

> Add Payload retrieval to Spans
> ------------------------------
>
>                 Key: LUCENE-1001
>                 URL: htt
ps://issues.apache.org/jira/browse/LUCENE-1001
>             Project: Lucene - Java
>          Issue Type: New Feature
>          Components: Search
>            Reporter: Grant Ingersoll
>            Assignee: Grant Ingersoll
>            Priority: Minor
>
> It will be nice to have access to payloads when doing
SpanQuerys.
> See http://www.gossamer-threads.com/lists/lucene/java-dev
/52270 and http://www.gossamer-threads.com/lists/lucene/java-dev
/51134
> Current API, added to Spans.java is below.  I will try
to post a patch as soon as I can figure out how to make it
work for unordered spans (I believe I have all the other
cases working).
> 
>  /**
>    * Returns the payload data for the current span.
>    * This is invalid until {link #next()} is called
for
>    * the first time.
>    * This method must not be called more than once
after each call
>    * of {link #next()}. However, payloads are
loaded lazily,
>    * so if the payload data for the current position is
not needed,
>    * this method may not be called at all for
performance reasons.<br>
>    * <br>
>    * <p><font color="#FF0000">
>    * WARNING: The status of the
<b>Payloads</b> feature is experimental.
>    * The APIs introduced here might change in the
future and will not be
>    * supported anymore in such a case.</font>
>    *
>    * return a List of byte arrays containing the data of
this payload
>    * throws IOException
>    */
>   // TODO: Remove warning after API has been finalized
>   List/*<byte[]>*/ getPayload() throws
IOException;
>   /**
>    * Checks if a payload can be loaded at this
position.
>    * <p/>
>    * Payloads can only be loaded once per call to
>    * {link #next()}.
>    * <p/>
>    * <p><font color="#FF0000">
>    * WARNING: The status of the
<b>Payloads</b> feature is experimental.
>    * The APIs introduced here might change in the
future and will not be
>    * supported anymore in such a case.</font>
>    *
>    * return true if there is a payload available at this
position that can be loaded
>    */
>   // TODO: Remove warning after API has been finalized
>   public boolean isPayloadAvailable();
> 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue
online.


------------------------------------------------------------
---------
To unsubscribe, e-mail: java-dev-unsubscribelucene.apache.org
For additional commands, e-mail: java-dev-helplucene.apache.org

    [ https://issues.apache.org/jira/browse
/LUCENE-1001?page=com.atlassian.jira.plugin.system.issuetabp
anels:comment-tabpanel#action_12527863 ] 

Paul Elschot commented on LUCENE-1001:
--------------------------------------

My mistake, I thought Spans was an abstract class, but it is
an interface.
That also means that Spans should not be changed at all,
interfaces are forever.

Something like this could do nicely:

public interface PayloadSpans extends Spans {
// as above
}

I'd prefer the payload "core" classes to stay in
their own package search/payload
because they may well turn out to be useful in other
circumstances, for example
as a way to avoid disjunctions with many terms.
At the moment I have no preference for a package for the
PayloadSpans above,
it could be search.spans or search.payloads.


> Add Payload retrieval to Spans
> ------------------------------
>
>                 Key: LUCENE-1001
>                 URL: htt
ps://issues.apache.org/jira/browse/LUCENE-1001
>             Project: Lucene - Java
>          Issue Type: New Feature
>          Components: Search
>            Reporter: Grant Ingersoll
>            Assignee: Grant Ingersoll
>            Priority: Minor
>
> It will be nice to have access to payloads when doing
SpanQuerys.
> See http://www.gossamer-threads.com/lists/lucene/java-dev
/52270 and http://www.gossamer-threads.com/lists/lucene/java-dev
/51134
> Current API, added to Spans.java is below.  I will try
to post a patch as soon as I can figure out how to make it
work for unordered spans (I believe I have all the other
cases working).
> 
>  /**
>    * Returns the payload data for the current span.
>    * This is invalid until {link #next()} is called
for
>    * the first time.
>    * This method must not be called more than once
after each call
>    * of {link #next()}. However, payloads are
loaded lazily,
>    * so if the payload data for the current position is
not needed,
>    * this method may not be called at all for
performance reasons.<br>
>    * <br>
>    * <p><font color="#FF0000">
>    * WARNING: The status of the
<b>Payloads</b> feature is experimental.
>    * The APIs introduced here might change in the
future and will not be
>    * supported anymore in such a case.</font>
>    *
>    * return a List of byte arrays containing the data of
this payload
>    * throws IOException
>    */
>   // TODO: Remove warning after API has been finalized
>   List/*<byte[]>*/ getPayload() throws
IOException;
>   /**
>    * Checks if a payload can be loaded at this
position.
>    * <p/>
>    * Payloads can only be loaded once per call to
>    * {link #next()}.
>    * <p/>
>    * <p><font color="#FF0000">
>    * WARNING: The status of the
<b>Payloads</b> feature is experimental.
>    * The APIs introduced here might change in the
future and will not be
>    * supported anymore in such a case.</font>
>    *
>    * return true if there is a payload available at this
position that can be loaded
>    */
>   // TODO: Remove warning after API has been finalized
>   public boolean isPayloadAvailable();
> 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue
online.


------------------------------------------------------------
---------
To unsubscribe, e-mail: java-dev-unsubscribelucene.apache.org
For additional commands, e-mail: java-dev-helplucene.apache.org

    [ https://issues.apache.org/jira/browse
/LUCENE-1001?page=com.atlassian.jira.plugin.system.issuetabp
anels:comment-tabpanel#action_12536872 ] 

Grant Ingersoll commented on LUCENE-1001:
-----------------------------------------


public interface PayloadSpans extends Spans { // as above }


I think this is problematic too, unfortunately, since many
spans actually contain other spans, so there is no way to
safely cast even in the internal implementations.

Alternative might be to add SpanQuery.getPayloadSpans() but
that is ugly, too.

I wish there was an equivalent way to deprecated that
allowed one to tell people new methods are coming, but that
won't break the existing interface.  Semantics of it would
need to be figured out, but it would be useful here to just
be able to let people know that we want to add to the Spans
interface, but they just get a warning when compiling until
we make it official.

I suppose the right thing to do if we really want this to
work is to deprecate Spans and SpanQuery.getSpans() and
introduce a new form of Spans (maybe as an abstract class
this time?)

Or am I missing something that provides a clearer way of
doing this?

> Add Payload retrieval to Spans
> ------------------------------
>
>                 Key: LUCENE-1001
>                 URL: htt
ps://issues.apache.org/jira/browse/LUCENE-1001
>             Project: Lucene - Java
>          Issue Type: New Feature
>          Components: Search
>            Reporter: Grant Ingersoll
>            Assignee: Grant Ingersoll
>            Priority: Minor
>
> It will be nice to have access to payloads when doing
SpanQuerys.
> See http://www.gossamer-threads.com/lists/lucene/java-dev
/52270 and http://www.gossamer-threads.com/lists/lucene/java-dev
/51134
> Current API, added to Spans.java is below.  I will try
to post a patch as soon as I can figure out how to make it
work for unordered spans (I believe I have all the other
cases working).
> 
>  /**
>    * Returns the payload data for the current span.
>    * This is invalid until {link #next()} is called
for
>    * the first time.
>    * This method must not be called more than once
after each call
>    * of {link #next()}. However, payloads are
loaded lazily,
>    * so if the payload data for the current position is
not needed,
>    * this method may not be called at all for
performance reasons.<br>
>    * <br>
>    * <p><font color="#FF0000">
>    * WARNING: The status of the
<b>Payloads</b> feature is experimental.
>    * The APIs introduced here might change in the
future and will not be
>    * supported anymore in such a case.</font>
>    *
>    * return a List of byte arrays containing the data of
this payload
>    * throws IOException
>    */
>   // TODO: Remove warning after API has been finalized
>   List/*<byte[]>*/ getPayload() throws
IOException;
>   /**
>    * Checks if a payload can be loaded at this
position.
>    * <p/>
>    * Payloads can only be loaded once per call to
>    * {link #next()}.
>    * <p/>
>    * <p><font color="#FF0000">
>    * WARNING: The status of the
<b>Payloads</b> feature is experimental.
>    * The APIs introduced here might change in the
future and will not be
>    * supported anymore in such a case.</font>
>    *
>    * return true if there is a payload available at this
position that can be loaded
>    */
>   // TODO: Remove warning after API has been finalized
>   public boolean isPayloadAvailable();
> 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue
online.


------------------------------------------------------------
---------
To unsubscribe, e-mail: java-dev-unsubscribelucene.apache.org
For additional commands, e-mail: java-dev-helplucene.apache.org

    [ https://issues.apache.org/jira/browse
/LUCENE-1001?page=com.atlassian.jira.plugin.system.issuetabp
anels:comment-tabpanel#action_12537082 ] 

Paul Elschot commented on LUCENE-1001:
--------------------------------------

I think I would just go ahead and create a parallel class
hierarchy starting from class PayloadSpanQuery with a
getPayloadSpans() method, and try and use delegation to the
various SpanQueries and their Spans as much as possible.
That means you would end up with this a few times:

return new PayLoadSpans () {
   Spans delegatedTo = aFinalSpans;
   .... some Spans methods directly delegated...
};

When this delegation happens too often, it  could even be
factored out into its own superclass.
If the delegation turns out to be a performance problem it
might be inlined, but that would mean code duplication.

For the rest, in case you need some existing SpanQuery
private methods you could change them to package private,
and move your classes to the search.spans package for that
reason.

> Add Payload retrieval to Spans
> ------------------------------
>
>                 Key: LUCENE-1001
>                 URL: htt
ps://issues.apache.org/jira/browse/LUCENE-1001
>             Project: Lucene - Java
>          Issue Type: New Feature
>          Components: Search
>            Reporter: Grant Ingersoll
>            Assignee: Grant Ingersoll
>            Priority: Minor
>
> It will be nice to have access to payloads when doing
SpanQuerys.
> See http://www.gossamer-threads.com/lists/lucene/java-dev
/52270 and http://www.gossamer-threads.com/lists/lucene/java-dev
/51134
> Current API, added to Spans.java is below.  I will try
to post a patch as soon as I can figure out how to make it
work for unordered spans (I believe I have all the other
cases working).
> 
>  /**
>    * Returns the payload data for the current span.
>    * This is invalid until {link #next()} is called
for
>    * the first time.
>    * This method must not be called more than once
after each call
>    * of {link #next()}. However, payloads are
loaded lazily,
>    * so if the payload data for the current position is
not needed,
>    * this method may not be called at all for
performance reasons.<br>
>    * <br>
>    * <p><font color="#FF0000">
>    * WARNING: The status of the
<b>Payloads</b> feature is experimental.
>    * The APIs introduced here might change in the
future and will not be
>    * supported anymore in such a case.</font>
>    *
>    * return a List of byte arrays containing the data of
this payload
>    * throws IOException
>    */
>   // TODO: Remove warning after API has been finalized
>   List/*<byte[]>*/ getPayload() throws
IOException;
>   /**
>    * Checks if a payload can be loaded at this
position.
>    * <p/>
>    * Payloads can only be loaded once per call to
>    * {link #next()}.
>    * <p/>
>    * <p><font color="#FF0000">
>    * WARNING: The status of the
<b>Payloads</b> feature is experimental.
>    * The APIs introduced here might change in the
future and will not be
>    * supported anymore in such a case.</font>
>    *
>    * return true if there is a payload available at this
position that can be loaded
>    */
>   // TODO: Remove warning after API has been finalized
>   public boolean isPayloadAvailable();
> 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue
online.


------------------------------------------------------------
---------
To unsubscribe, e-mail: java-dev-unsubscribelucene.apache.org
For additional commands, e-mail: java-dev-helplucene.apache.org