/**
* Copyright (C) 2012 Red Hat, Inc. (jdcasey@commonjava.org)
*
* Licensed 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.commonjava.cartographer.graph.filter;
import static org.apache.commons.lang.StringUtils.join;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import org.apache.commons.codec.digest.DigestUtils;
import org.commonjava.maven.atlas.graph.rel.ProjectRelationship;
import org.commonjava.maven.atlas.graph.rel.RelationshipType;
import org.commonjava.maven.atlas.ident.ref.ProjectRef;
public abstract class AbstractTypedFilter
implements ProjectRelationshipFilter
{
// private final Logger logger = new Logger( getClass() );
/**
*
*/
private static final long serialVersionUID = 1L;
private final Set<RelationshipType> types;
private final Set<RelationshipType> descendantTypes;
private final boolean includeManagedInfo;
private final boolean includeConcreteInfo;
private transient String longId;
private transient String shortId;
protected AbstractTypedFilter( final RelationshipType type, final RelationshipType descendantType,
final boolean includeManagedInfo, final boolean includeConcreteInfo )
{
this.types = Collections.unmodifiableSet( Collections.singleton( type ) );
this.descendantTypes = Collections.unmodifiableSet( Collections.singleton( descendantType ) );
this.includeManagedInfo = includeManagedInfo;
this.includeConcreteInfo = includeConcreteInfo;
}
protected AbstractTypedFilter( final RelationshipType type, final Collection<RelationshipType> descendantTypes,
final boolean includeManagedInfo, final boolean includeConcreteInfo )
{
if ( type == null )
{
this.types =
Collections.unmodifiableSet( new HashSet<RelationshipType>( Arrays.asList( RelationshipType.values() ) ) );
}
else
{
this.types = Collections.unmodifiableSet( Collections.singleton( type ) );
}
if ( descendantTypes == null || descendantTypes.isEmpty() )
{
this.descendantTypes =
Collections.unmodifiableSet( new HashSet<RelationshipType>( Arrays.asList( RelationshipType.values() ) ) );
}
else
{
this.descendantTypes = Collections.unmodifiableSet( new HashSet<RelationshipType>( descendantTypes ) );
}
this.includeManagedInfo = includeManagedInfo;
this.includeConcreteInfo = includeConcreteInfo;
}
protected AbstractTypedFilter( final Collection<RelationshipType> types,
final Collection<RelationshipType> descendantTypes,
final boolean includeManagedInfo, final boolean includeConcreteInfo )
{
if ( types == null || types.isEmpty() )
{
this.types =
Collections.unmodifiableSet( new HashSet<RelationshipType>( Arrays.asList( RelationshipType.values() ) ) );
}
else
{
this.types = Collections.unmodifiableSet( new HashSet<RelationshipType>( types ) );
}
if ( descendantTypes == null || descendantTypes.isEmpty() )
{
this.descendantTypes =
Collections.unmodifiableSet( new HashSet<RelationshipType>( Arrays.asList( RelationshipType.values() ) ) );
}
else
{
this.descendantTypes = Collections.unmodifiableSet( new HashSet<RelationshipType>( descendantTypes ) );
}
this.includeManagedInfo = includeManagedInfo;
this.includeConcreteInfo = includeConcreteInfo;
}
protected AbstractTypedFilter( final RelationshipType type, final boolean hasDescendants,
final boolean includeManagedInfo, final boolean includeConcreteInfo )
{
if ( type == null )
{
this.types =
Collections.unmodifiableSet( new HashSet<RelationshipType>( Arrays.asList( RelationshipType.values() ) ) );
}
else
{
this.types = Collections.unmodifiableSet( Collections.singleton( type ) );
}
if ( hasDescendants )
{
this.descendantTypes = types;
}
else
{
this.descendantTypes = Collections.unmodifiableSet( Collections.<RelationshipType> emptySet() );
}
this.includeManagedInfo = includeManagedInfo;
this.includeConcreteInfo = includeConcreteInfo;
}
@Override
public final boolean accept( final ProjectRelationship<?, ?> rel )
{
if ( types.contains( rel.getType() ) )
{
final boolean accepted = doAccept( rel );
if ( accepted )
{
// logger.info( "ACCEPT relationship: %s. Type is in: %s, and was accepted in second-level analysis", rel,
// types );
}
else
{
// logger.info( "REJECT relationship: %s. Type is in: %s but was rejected by second-level analysis.", rel,
// types );
}
return accepted;
}
// else
// {
// logger.info( "REJECT relationship: %s. Type is not in: %s", rel, types );
// }
return false;
}
@Override
public Set<ProjectRef> getDepExcludes()
{
return null;
}
public Set<RelationshipType> getRelationshipTypes()
{
return types;
}
public Set<RelationshipType> getDescendantRelationshipTypes()
{
return descendantTypes;
}
protected boolean doAccept( final ProjectRelationship<?, ?> rel )
{
// base functionality is only to check that the type is appropriate.
return true;
}
@Override
public int hashCode()
{
final int prime = 31;
int result = 1;
result = prime * result + ( ( descendantTypes == null ) ? 0 : descendantTypes.hashCode() );
result = prime * result + ( includeConcreteInfo ? 1231 : 1237 );
result = prime * result + ( includeManagedInfo ? 1231 : 1237 );
result = prime * result + ( ( types == null ) ? 0 : types.hashCode() );
return result;
}
@Override
public boolean equals( final Object obj )
{
if ( this == obj )
{
return true;
}
if ( obj == null )
{
return false;
}
if ( getClass() != obj.getClass() )
{
return false;
}
final AbstractTypedFilter other = (AbstractTypedFilter) obj;
if ( descendantTypes == null )
{
if ( other.descendantTypes != null )
{
return false;
}
}
else if ( !descendantTypes.equals( other.descendantTypes ) )
{
return false;
}
if ( includeConcreteInfo != other.includeConcreteInfo )
{
return false;
}
if ( includeManagedInfo != other.includeManagedInfo )
{
return false;
}
if ( types == null )
{
if ( other.types != null )
{
return false;
}
}
else if ( !types.equals( other.types ) )
{
return false;
}
return true;
}
@Override
public String getLongId()
{
if ( longId == null )
{
final StringBuilder sb = new StringBuilder();
final String abbreviatedPackage = getClass().getPackage()
.getName()
.replaceAll( "([a-zA-Z])[a-zA-Z]+", "$1" );
sb.append( abbreviatedPackage )
.append( '.' )
.append( getClass().getSimpleName() )
.append( "[types:{" )
.append( join( types, "," ) )
.append( "}, next-types:{" )
.append( join( descendantTypes, "," ) )
.append( "}, concrete:" )
.append( includeConcreteInfo )
.append( ", managed:" )
.append( includeManagedInfo );
renderIdAttributes( sb );
sb.append( ']' );
longId = sb.toString();
}
return longId;
}
protected void renderIdAttributes( final StringBuilder sb )
{
}
@Override
public String toString()
{
return getLongId();
}
@Override
public String getCondensedId()
{
if ( shortId == null )
{
shortId = DigestUtils.shaHex( getLongId() );
}
return shortId;
}
@Override
public boolean includeManagedRelationships()
{
return includeManagedInfo;
}
@Override
public boolean includeConcreteRelationships()
{
return includeConcreteInfo;
}
@Override
public Set<RelationshipType> getAllowedTypes()
{
final Set<RelationshipType> result = new HashSet<RelationshipType>();
result.addAll( types );
result.addAll( descendantTypes );
return result;
}
}