| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_162) on Mon Apr 23 13:11:19 EDT 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ColumnVisibility (Apache Accumulo Project 1.9.0 API)</title> |
| <meta name="date" content="2018-04-23"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ColumnVisibility (Apache Accumulo Project 1.9.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ColumnVisibility.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.Node.html" title="class in org.apache.accumulo.core.security"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/accumulo/core/security/ColumnVisibility.html" target="_top">Frames</a></li> |
| <li><a href="ColumnVisibility.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.accumulo.core.security</div> |
| <h2 title="Class ColumnVisibility" class="title">Class ColumnVisibility</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.accumulo.core.security.ColumnVisibility</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ColumnVisibility</span> |
| extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Validate the column visibility is a valid expression and set the visibility for a Mutation. See |
| <a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#ColumnVisibility-byte:A-"><code>ColumnVisibility(byte[])</code></a> for the definition of an expression. |
| |
| <p> |
| The expression is a sequence of characters from the set [A-Za-z0-9_-.] along with the binary |
| operators "&" and "|" indicating that both operands are necessary, or the either is |
| necessary. The following are valid expressions for visibility: |
| |
| <pre> |
| A |
| A|B |
| (A|B)&(C|D) |
| orange|(red&yellow) |
| </pre> |
| |
| <p> |
| The following are not valid expressions for visibility: |
| |
| <pre> |
| A|B&C |
| A=B |
| A|B| |
| A&|B |
| () |
| ) |
| dog|!cat |
| </pre> |
| |
| <p> |
| In addition to the base set of visibilities, any character can be used in the expression if it is |
| quoted. If the quoted term contains '"' or '\', then escape the character with '\'. The |
| <a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#quote-java.lang.String-"><code>quote(String)</code></a> method can be used to properly quote and escape terms automatically. The |
| following is an example of a quoted term: |
| |
| <pre> |
| "A#C" & B |
| </pre></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.Node.html" title="class in org.apache.accumulo.core.security">ColumnVisibility.Node</a></span></code> |
| <div class="block">A node in the parse tree for a visibility expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.NodeComparator.html" title="class in org.apache.accumulo.core.security">ColumnVisibility.NodeComparator</a></span></code> |
| <div class="block">A node comparator.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.NodeType.html" title="enum in org.apache.accumulo.core.security">ColumnVisibility.NodeType</a></span></code> |
| <div class="block">The node types in a parse tree for a visibility expression.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#ColumnVisibility--">ColumnVisibility</a></span>()</code> |
| <div class="block">Creates an empty visibility.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#ColumnVisibility-byte:A-">ColumnVisibility</a></span>(byte[] expression)</code> |
| <div class="block">Creates a column visibility for a Mutation from a string already encoded in UTF-8 bytes.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#ColumnVisibility-java.lang.String-">ColumnVisibility</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> expression)</code> |
| <div class="block">Creates a column visibility for a Mutation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#ColumnVisibility-org.apache.hadoop.io.Text-">ColumnVisibility</a></span>(org.apache.hadoop.io.Text expression)</code> |
| <div class="block">Creates a column visibility for a Mutation.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#equals-org.apache.accumulo.core.security.ColumnVisibility-">equals</a></span>(<a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html" title="class in org.apache.accumulo.core.security">ColumnVisibility</a> otherLe)</code> |
| <div class="block">Compares two ColumnVisibilities for string equivalence, not as a meaningful comparison of terms |
| and conditions.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#equals-java.lang.Object-">equals</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</code> |
| <div class="block">See <a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#equals-org.apache.accumulo.core.security.ColumnVisibility-"><code>equals(ColumnVisibility)</code></a></div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#flatten--">flatten</a></span>()</code> |
| <div class="block">Generates a byte[] that represents a normalized, but logically equivalent, form of this |
| evaluator's expression.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#getExpression--">getExpression</a></span>()</code> |
| <div class="block">Accessor for the underlying byte string.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.Node.html" title="class in org.apache.accumulo.core.security">ColumnVisibility.Node</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#getParseTree--">getParseTree</a></span>()</code> |
| <div class="block">Gets the parse tree for this column visibility.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#hashCode--">hashCode</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.Node.html" title="class in org.apache.accumulo.core.security">ColumnVisibility.Node</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#normalize-org.apache.accumulo.core.security.ColumnVisibility.Node-byte:A-">normalize</a></span>(<a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.Node.html" title="class in org.apache.accumulo.core.security">ColumnVisibility.Node</a> root, |
| byte[] expression)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.Node.html" title="class in org.apache.accumulo.core.security">ColumnVisibility.Node</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#normalize-org.apache.accumulo.core.security.ColumnVisibility.Node-byte:A-org.apache.accumulo.core.security.ColumnVisibility.NodeComparator-">normalize</a></span>(<a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.Node.html" title="class in org.apache.accumulo.core.security">ColumnVisibility.Node</a> root, |
| byte[] expression, |
| <a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.NodeComparator.html" title="class in org.apache.accumulo.core.security">ColumnVisibility.NodeComparator</a> comparator)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#quote-byte:A-">quote</a></span>(byte[] term)</code> |
| <div class="block">Properly quotes terms in a column visibility expression.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#quote-java.lang.String-">quote</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> term)</code> |
| <div class="block">Properly quotes terms in a column visibility expression.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#stringify-org.apache.accumulo.core.security.ColumnVisibility.Node-byte:A-java.lang.StringBuilder-">stringify</a></span>(<a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.Node.html" title="class in org.apache.accumulo.core.security">ColumnVisibility.Node</a> root, |
| byte[] expression, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> out)</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ColumnVisibility--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ColumnVisibility</h4> |
| <pre>public ColumnVisibility()</pre> |
| <div class="block">Creates an empty visibility. Normally, elements with empty visibility can be seen by everyone. |
| Though, one could change this behavior with filters.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#ColumnVisibility-java.lang.String-"><code>ColumnVisibility(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ColumnVisibility-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ColumnVisibility</h4> |
| <pre>public ColumnVisibility(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> expression)</pre> |
| <div class="block">Creates a column visibility for a Mutation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expression</code> - An expression of the rights needed to see this mutation. The expression syntax is |
| defined at the class-level documentation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ColumnVisibility-org.apache.hadoop.io.Text-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ColumnVisibility</h4> |
| <pre>public ColumnVisibility(org.apache.hadoop.io.Text expression)</pre> |
| <div class="block">Creates a column visibility for a Mutation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expression</code> - visibility expression</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#ColumnVisibility-java.lang.String-"><code>ColumnVisibility(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ColumnVisibility-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ColumnVisibility</h4> |
| <pre>public ColumnVisibility(byte[] expression)</pre> |
| <div class="block">Creates a column visibility for a Mutation from a string already encoded in UTF-8 bytes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expression</code> - visibility expression, encoded as UTF-8 bytes</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#ColumnVisibility-java.lang.String-"><code>ColumnVisibility(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getExpression--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExpression</h4> |
| <pre>public byte[] getExpression()</pre> |
| <div class="block">Accessor for the underlying byte string.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>byte array representation of a visibility expression</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="normalize-org.apache.accumulo.core.security.ColumnVisibility.Node-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>normalize</h4> |
| <pre>public static <a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.Node.html" title="class in org.apache.accumulo.core.security">ColumnVisibility.Node</a> normalize(<a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.Node.html" title="class in org.apache.accumulo.core.security">ColumnVisibility.Node</a> root, |
| byte[] expression)</pre> |
| </li> |
| </ul> |
| <a name="normalize-org.apache.accumulo.core.security.ColumnVisibility.Node-byte:A-org.apache.accumulo.core.security.ColumnVisibility.NodeComparator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>normalize</h4> |
| <pre>public static <a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.Node.html" title="class in org.apache.accumulo.core.security">ColumnVisibility.Node</a> normalize(<a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.Node.html" title="class in org.apache.accumulo.core.security">ColumnVisibility.Node</a> root, |
| byte[] expression, |
| <a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.NodeComparator.html" title="class in org.apache.accumulo.core.security">ColumnVisibility.NodeComparator</a> comparator)</pre> |
| </li> |
| </ul> |
| <a name="stringify-org.apache.accumulo.core.security.ColumnVisibility.Node-byte:A-java.lang.StringBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stringify</h4> |
| <pre>public static void stringify(<a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.Node.html" title="class in org.apache.accumulo.core.security">ColumnVisibility.Node</a> root, |
| byte[] expression, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> out)</pre> |
| </li> |
| </ul> |
| <a name="flatten--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>flatten</h4> |
| <pre>public byte[] flatten()</pre> |
| <div class="block">Generates a byte[] that represents a normalized, but logically equivalent, form of this |
| evaluator's expression.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>normalized expression in byte[] form</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</pre> |
| <div class="block">See <a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#equals-org.apache.accumulo.core.security.ColumnVisibility-"><code>equals(ColumnVisibility)</code></a></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals-org.apache.accumulo.core.security.ColumnVisibility-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(<a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html" title="class in org.apache.accumulo.core.security">ColumnVisibility</a> otherLe)</pre> |
| <div class="block">Compares two ColumnVisibilities for string equivalence, not as a meaningful comparison of terms |
| and conditions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>otherLe</code> - other column visibility</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this visibility equals the other via string comparison</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParseTree--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParseTree</h4> |
| <pre>public <a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.Node.html" title="class in org.apache.accumulo.core.security">ColumnVisibility.Node</a> getParseTree()</pre> |
| <div class="block">Gets the parse tree for this column visibility.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>parse tree node</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="quote-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>quote</h4> |
| <pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> quote(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> term)</pre> |
| <div class="block">Properly quotes terms in a column visibility expression. If no quoting is needed, then nothing |
| is done. |
| |
| <p> |
| Examples of using quote : |
| |
| <pre> |
| import static org.apache.accumulo.core.security.ColumnVisibility.quote; |
| . |
| . |
| . |
| String s = quote("A#C") + "&" + quote("FOO"); |
| ColumnVisibility cv = new ColumnVisibility(s); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>term</code> - term to quote</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>quoted term (unquoted if unnecessary)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="quote-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>quote</h4> |
| <pre>public static byte[] quote(byte[] term)</pre> |
| <div class="block">Properly quotes terms in a column visibility expression. If no quoting is needed, then nothing |
| is done.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>term</code> - term to quote, encoded as UTF-8 bytes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>quoted term (unquoted if unnecessary), encoded as UTF-8 bytes</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.html#quote-java.lang.String-"><code>quote(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ColumnVisibility.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/accumulo/core/security/ColumnVisibility.Node.html" title="class in org.apache.accumulo.core.security"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/accumulo/core/security/ColumnVisibility.html" target="_top">Frames</a></li> |
| <li><a href="ColumnVisibility.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2011–2018 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |