/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
package org.apache.directory.studio.ldapbrowser.core.model.filter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.apache.directory.studio.ldapbrowser.core.model.filter.parser.LdapFilterToken;
/**
* The LdapFilterExtensibleComponent represents an extensible filter.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class LdapFilterExtensibleComponent extends LdapFilterComponent
{
private LdapFilterToken attributeToken;
private LdapFilterToken dnAttrColonToken;
private LdapFilterToken dnAttrToken;
private LdapFilterToken matchingRuleColonToken;
private LdapFilterToken matchingRuleToken;
private LdapFilterToken equalsColonToken;
private LdapFilterToken equalsToken;
private LdapFilterToken valueToken;
/**
* Creates a new instance of LdapFilterExtensibleComponent.
*
* @param parent the parent filter
*/
public LdapFilterExtensibleComponent( LdapFilter parent )
{
super( parent );
}
/**
* Sets the attribute token.
*
* @param attributeToken the attribute token
*
* @return true, if setting the attribute token was successful,false otherwise.
*/
public boolean setAttributeToken( LdapFilterToken attributeToken )
{
if ( this.attributeToken == null && attributeToken != null
&& attributeToken.getType() == LdapFilterToken.EXTENSIBLE_ATTRIBUTE )
{
if ( super.getStartToken() == null )
{
super.setStartToken( attributeToken );
}
this.attributeToken = attributeToken;
return true;
}
else
{
return false;
}
}
/**
* Gets the attribute token.
*
* @return the attribute token, or null if not set
*/
public LdapFilterToken getAttributeToken()
{
return attributeToken;
}
/**
* Sets the dn attr colon token.
*
* @param dnAttrColonToken the dn attr colon token
*
* @return true, if setting the dn attr colon token was sucessful, false otherwise
*/
public boolean setDnAttrColonToken( LdapFilterToken dnAttrColonToken )
{
if ( this.dnAttrColonToken == null && dnAttrColonToken != null
&& dnAttrColonToken.getType() == LdapFilterToken.EXTENSIBLE_DNATTR_COLON )
{
if ( super.getStartToken() == null )
{
super.setStartToken( dnAttrColonToken );
}
this.dnAttrColonToken = dnAttrColonToken;
return true;
}
else
{
return false;
}
}
/**
* Gets the dn attr colon token.
*
* @return the dn attr colon token, or null if not set
*/
public LdapFilterToken getDnAttrColonToken()
{
return dnAttrColonToken;
}
/**
* Sets the dn attr token.
*
* @param dnAttrToken the dn attr token
*
* @return true, if setting the dn attr token was successful, false otherwise
*/
public boolean setDnAttrToken( LdapFilterToken dnAttrToken )
{
if ( this.dnAttrToken == null && dnAttrToken != null
&& dnAttrToken.getType() == LdapFilterToken.EXTENSIBLE_DNATTR )
{
this.dnAttrToken = dnAttrToken;
return true;
}
else
{
return false;
}
}
/**
* Gets the dn attr token.
*
* @return the dn attr token, or null if not set
*/
public LdapFilterToken getDnAttrToken()
{
return dnAttrToken;
}
/**
* Sets the matching rule colon token.
*
* @param matchingRuleColonToken the matching rule colon token
*
* @return true, if setting the matching rule colon token was successful, false otherwise
*/
public boolean setMatchingRuleColonToken( LdapFilterToken matchingRuleColonToken )
{
if ( this.matchingRuleColonToken == null && matchingRuleColonToken != null
&& matchingRuleColonToken.getType() == LdapFilterToken.EXTENSIBLE_MATCHINGRULEOID_COLON )
{
if ( super.getStartToken() == null )
{
super.setStartToken( matchingRuleColonToken );
}
this.matchingRuleColonToken = matchingRuleColonToken;
return true;
}
else
{
return false;
}
}
/**
* Gets the matching rule colon token.
*
* @return the matching rule colon token, or null if not set
*/
public LdapFilterToken getMatchingRuleColonToken()
{
return matchingRuleColonToken;
}
/**
* Sets the matching rule token.
*
* @param matchingRuleToken the matching rule token
*
* @return true, if setting the matching rule token was successful, false otherwise
*/
public boolean setMatchingRuleToken( LdapFilterToken matchingRuleToken )
{
if ( this.matchingRuleToken == null && matchingRuleToken != null
&& matchingRuleToken.getType() == LdapFilterToken.EXTENSIBLE_MATCHINGRULEOID )
{
this.matchingRuleToken = matchingRuleToken;
return true;
}
else
{
return false;
}
}
/**
* Gets the matching rule token.
*
* @return the matching rule token, or null if not set
*/
public LdapFilterToken getMatchingRuleToken()
{
return matchingRuleToken;
}
/**
* Sets the equals colon token.
*
* @param equalsColonToken the equals colon token
*
* @return true, if setting the equals colon token was sucessful, false otherwise
*/
public boolean setEqualsColonToken( LdapFilterToken equalsColonToken )
{
if ( this.equalsColonToken == null && equalsColonToken != null
&& equalsColonToken.getType() == LdapFilterToken.EXTENSIBLE_EQUALS_COLON )
{
this.equalsColonToken = equalsColonToken;
return true;
}
else
{
return false;
}
}
/**
* Gets the equals colon token.
*
* @return the equals colon token, or null if not set
*/
public LdapFilterToken getEqualsColonToken()
{
return equalsColonToken;
}
/**
* Sets the equals token.
*
* @param equalsToken the equals token
*
* @return true, if setting the equals token was successful, false otherwise
*/
public boolean setEqualsToken( LdapFilterToken equalsToken )
{
if ( this.equalsToken == null && equalsToken != null && equalsToken.getType() == LdapFilterToken.EQUAL )
{
this.equalsToken = equalsToken;
return true;
}
else
{
return false;
}
}
/**
* Gets the equals token.
*
* @return the equals token, or null if not set
*/
public LdapFilterToken getEqualsToken()
{
return equalsToken;
}
/**
* Sets the value token.
*
* @param valueToken the value token
*
* @return true, if setting the value token was successful, false otherwise
*/
public boolean setValueToken( LdapFilterToken valueToken )
{
if ( this.valueToken == null && valueToken != null && valueToken.getType() == LdapFilterToken.VALUE )
{
this.valueToken = valueToken;
return true;
}
else
{
return false;
}
}
/**
* Gets the value token.
*
* @return the value token, or null if not set
*/
public LdapFilterToken getValueToken()
{
return this.valueToken;
}
/**
* @see org.apache.directory.studio.ldapbrowser.core.model.filter.LdapFilterComponent#isValid()
*/
public boolean isValid()
{
return startToken != null
&& equalsColonToken != null
& equalsToken != null
&& valueToken != null
&&
( ( attributeToken != null
&& ( ( dnAttrColonToken == null && dnAttrToken == null ) || ( dnAttrColonToken != null && dnAttrToken != null ) ) && ( ( matchingRuleColonToken == null && matchingRuleToken == null ) || ( matchingRuleColonToken != null && matchingRuleToken != null ) ) ) || ( attributeToken == null
&& ( ( dnAttrColonToken == null && dnAttrToken == null ) || ( dnAttrColonToken != null && dnAttrToken != null ) )
&& matchingRuleColonToken != null && matchingRuleToken != null ) );
}
/**
* @see org.apache.directory.studio.ldapbrowser.core.model.filter.LdapFilterComponent#getTokens()
*/
public LdapFilterToken[] getTokens()
{
// collect tokens
List<LdapFilterToken> tokenList = new ArrayList<LdapFilterToken>();
if ( attributeToken != null )
{
tokenList.add( attributeToken );
}
if ( dnAttrColonToken != null )
{
tokenList.add( dnAttrColonToken );
}
if ( dnAttrToken != null )
{
tokenList.add( dnAttrToken );
}
if ( matchingRuleColonToken != null )
{
tokenList.add( matchingRuleColonToken );
}
if ( matchingRuleToken != null )
{
tokenList.add( matchingRuleToken );
}
if ( equalsColonToken != null )
{
tokenList.add( equalsColonToken );
}
if ( equalsToken != null )
{
tokenList.add( equalsToken );
}
if ( valueToken != null )
{
tokenList.add( valueToken );
}
// sort tokens
LdapFilterToken[] tokens = tokenList.toArray( new LdapFilterToken[tokenList.size()] );
Arrays.sort( tokens );
// return
return tokens;
}
/**
* @see java.lang.Object#toString()
*/
public String toString()
{
return ( attributeToken != null ? startToken.getValue() : "" ) //$NON-NLS-1$
+ ( dnAttrColonToken != null ? dnAttrColonToken.getValue() : "" ) //$NON-NLS-1$
+ ( dnAttrToken != null ? dnAttrToken.getValue() : "" ) //$NON-NLS-1$
+ ( matchingRuleColonToken != null ? matchingRuleColonToken.getValue() : "" ) //$NON-NLS-1$
+ ( matchingRuleToken != null ? matchingRuleToken.getValue() : "" ) //$NON-NLS-1$
+ ( equalsColonToken != null ? equalsColonToken.getValue() : "" ) //$NON-NLS-1$
+ ( equalsToken != null ? equalsToken.getValue() : "" ) //$NON-NLS-1$
+ ( valueToken != null ? valueToken.getValue() : "" ); //$NON-NLS-1$
}
/**
* @see org.apache.directory.studio.ldapbrowser.core.model.filter.LdapFilterComponent#addFilter(org.apache.directory.studio.ldapbrowser.core.model.filter.LdapFilter)
*/
public boolean addFilter( LdapFilter filter )
{
return false;
}
/**
* @see org.apache.directory.studio.ldapbrowser.core.model.filter.LdapFilterComponent#getInvalidFilters()
*/
public LdapFilter[] getInvalidFilters()
{
if ( isValid() )
{
return new LdapFilter[0];
}
else
{
return new LdapFilter[]
{ parent };
}
}
/**
* @see org.apache.directory.studio.ldapbrowser.core.model.filter.LdapFilterComponent#getFilter(int)
*/
public LdapFilter getFilter( int offset )
{
if ( startToken != null && startToken.getOffset() <= offset
&& offset < startToken.getOffset() + toString().length() )
{
return parent;
}
else
{
return null;
}
}
/**
* @see org.apache.directory.studio.ldapbrowser.core.model.filter.LdapFilterComponent#getInvalidCause()
*/
public String getInvalidCause()
{
if ( dnAttrColonToken != null && dnAttrToken == null )
{
return Messages.LdapFilterExtensibleComponent_MissingDn;
}
else if ( matchingRuleColonToken != null && matchingRuleToken == null )
{
return Messages.LdapFilterExtensibleComponent_MissingMatchingRule;
}
else if ( equalsColonToken == null )
{
return Messages.LdapFilterExtensibleComponent_MissingColon;
}
else if ( equalsToken == null )
{
return Messages.LdapFilterExtensibleComponent_MissingEquals;
}
else if ( attributeToken == null )
{
return Messages.LdapFilterExtensibleComponent_MissingAttributeType;
}
else if ( valueToken != null )
{
return Messages.LdapFilterExtensibleComponent_MissingValue;
}
else
{
return null;
}
}
}